src/common/kernel-consumer/kernel-consumer.c

   1 /*
   2  * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
   3  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #define _LGPL_SOURCE
  21 #include <assert.h>
  22 #include <poll.h>
  23 #include <pthread.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <sys/mman.h>
  27 #include <sys/socket.h>
  28 #include <sys/types.h>
  29 #include <inttypes.h>
  30 #include <unistd.h>
  31 #include <sys/stat.h>
  32
  33 #include <bin/lttng-consumerd/health-consumerd.h>
  34 #include <common/common.h>
  35 #include <common/kernel-ctl/kernel-ctl.h>
  36 #include <common/sessiond-comm/sessiond-comm.h>
  37 #include <common/sessiond-comm/relayd.h>
  38 #include <common/compat/fcntl.h>
  39 #include <common/compat/endian.h>
  40 #include <common/pipe.h>
  41 #include <common/relayd/relayd.h>
  42 #include <common/utils.h>
  43 #include <common/consumer/consumer-stream.h>
  44 #include <common/index/index.h>
  45 #include <common/consumer/consumer-timer.h>
  46
  47 #include "kernel-consumer.h"
  48
  49 extern struct lttng_consumer_global_data consumer_data;
  50 extern int consumer_poll_timeout;
  51
  52 /*
  53  * Take a snapshot for a specific fd
  54  *
  55  * Returns 0 on success, < 0 on error
  56  */
  57 int lttng_kconsumer_take_snapshot(struct lttng_consumer_stream *stream)
  58 {
  59         int ret = 0;
  60         int infd = stream->wait_fd;
  61
  62         ret = kernctl_snapshot(infd);
  63         if (ret != 0) {
  64                 PERROR("Getting sub-buffer snapshot.");
  65         }
  66
  67         return ret;
  68 }
  69
  70 /*
  71  * Sample consumed and produced positions for a specific fd.
  72  *
  73  * Returns 0 on success, < 0 on error.
  74  */
  75 int lttng_kconsumer_sample_snapshot_positions(
  76                 struct lttng_consumer_stream *stream)
  77 {
  78         assert(stream);
  79
  80         return kernctl_snapshot_sample_positions(stream->wait_fd);
  81 }
  82
  83 /*
  84  * Get the produced position
  85  *
  86  * Returns 0 on success, < 0 on error
  87  */
  88 int lttng_kconsumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
  89                 unsigned long *pos)
  90 {
  91         int ret;
  92         int infd = stream->wait_fd;
  93
  94         ret = kernctl_snapshot_get_produced(infd, pos);
  95         if (ret != 0) {
  96                 PERROR("kernctl_snapshot_get_produced");
  97         }
  98
  99         return ret;
 100 }
 101
 102 /*
 103  * Get the consumerd position
 104  *
 105  * Returns 0 on success, < 0 on error
 106  */
 107 int lttng_kconsumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
 108                 unsigned long *pos)
 109 {
 110         int ret;
 111         int infd = stream->wait_fd;
 112
 113         ret = kernctl_snapshot_get_consumed(infd, pos);
 114         if (ret != 0) {
 115                 PERROR("kernctl_snapshot_get_consumed");
 116         }
 117
 118         return ret;
 119 }
 120
 121 /*
 122  * Take a snapshot of all the stream of a channel
 123  *
 124  * Returns 0 on success, < 0 on error
 125  */
 126 int lttng_kconsumer_snapshot_channel(uint64_t key, char *path,
 127                 uint64_t relayd_id, uint64_t nb_packets_per_stream,
 128                 struct lttng_consumer_local_data *ctx)
 129 {
 130         int ret;
 131         struct lttng_consumer_channel *channel;
 132         struct lttng_consumer_stream *stream;
 133
 134         DBG("Kernel consumer snapshot channel %" PRIu64, key);
 135
 136         rcu_read_lock();
 137
 138         channel = consumer_find_channel(key);
 139         if (!channel) {
 140                 ERR("No channel found for key %" PRIu64, key);
 141                 ret = -1;
 142                 goto end;
 143         }
 144
 145         /* Splice is not supported yet for channel snapshot. */
 146         if (channel->output != CONSUMER_CHANNEL_MMAP) {
 147                 ERR("Unsupported output %d", channel->output);
 148                 ret = -1;
 149                 goto end;
 150         }
 151
 152         cds_list_for_each_entry(stream, &channel->streams.head, send_node) {
 153                 unsigned long consumed_pos, produced_pos;
 154
 155                 health_code_update();
 156
 157                 /*
 158                  * Lock stream because we are about to change its state.
 159                  */
 160                 pthread_mutex_lock(&stream->lock);
 161
 162                 /*
 163                  * Assign the received relayd ID so we can use it for streaming. The streams
 164                  * are not visible to anyone so this is OK to change it.
 165                  */
 166                 stream->net_seq_idx = relayd_id;
 167                 channel->relayd_id = relayd_id;
 168                 if (relayd_id != (uint64_t) -1ULL) {
 169                         ret = consumer_send_relayd_stream(stream, path);
 170                         if (ret < 0) {
 171                                 ERR("sending stream to relayd");
 172                                 goto end_unlock;
 173                         }
 174                 } else {
 175                         ret = utils_create_stream_file(path, stream->name,
 176                                         stream->chan->tracefile_size,
 177                                         stream->tracefile_count_current,
 178                                         stream->uid, stream->gid, NULL);
 179                         if (ret < 0) {
 180                                 ERR("utils_create_stream_file");
 181                                 goto end_unlock;
 182                         }
 183
 184                         stream->out_fd = ret;
 185                         stream->tracefile_size_current = 0;
 186
 187                         DBG("Kernel consumer snapshot stream %s/%s (%" PRIu64 ")",
 188                                         path, stream->name, stream->key);
 189                 }
 190
 191                 ret = kernctl_buffer_flush_empty(stream->wait_fd);
 192                 if (ret < 0) {
 193                         /*
 194                          * Doing a buffer flush which does not take into
 195                          * account empty packets. This is not perfect
 196                          * for stream intersection, but required as a
 197                          * fall-back when "flush_empty" is not
 198                          * implemented by lttng-modules.
 199                          */
 200                         ret = kernctl_buffer_flush(stream->wait_fd);
 201                         if (ret < 0) {
 202                                 ERR("Failed to flush kernel stream");
 203                                 goto end_unlock;
 204                         }
 205                         goto end_unlock;
 206                 }
 207
 208                 ret = lttng_kconsumer_take_snapshot(stream);
 209                 if (ret < 0) {
 210                         ERR("Taking kernel snapshot");
 211                         goto end_unlock;
 212                 }
 213
 214                 ret = lttng_kconsumer_get_produced_snapshot(stream, &produced_pos);
 215                 if (ret < 0) {
 216                         ERR("Produced kernel snapshot position");
 217                         goto end_unlock;
 218                 }
 219
 220                 ret = lttng_kconsumer_get_consumed_snapshot(stream, &consumed_pos);
 221                 if (ret < 0) {
 222                         ERR("Consumerd kernel snapshot position");
 223                         goto end_unlock;
 224                 }
 225
 226                 if (stream->max_sb_size == 0) {
 227                         ret = kernctl_get_max_subbuf_size(stream->wait_fd,
 228                                         &stream->max_sb_size);
 229                         if (ret < 0) {
 230                                 ERR("Getting kernel max_sb_size");
 231                                 goto end_unlock;
 232                         }
 233                 }
 234
 235                 consumed_pos = consumer_get_consume_start_pos(consumed_pos,
 236                                 produced_pos, nb_packets_per_stream,
 237                                 stream->max_sb_size);
 238
 239                 while (consumed_pos < produced_pos) {
 240                         ssize_t read_len;
 241                         unsigned long len, padded_len;
 242
 243                         health_code_update();
 244
 245                         DBG("Kernel consumer taking snapshot at pos %lu", consumed_pos);
 246
 247                         ret = kernctl_get_subbuf(stream->wait_fd, &consumed_pos);
 248                         if (ret < 0) {
 249                                 if (ret != -EAGAIN) {
 250                                         PERROR("kernctl_get_subbuf snapshot");
 251                                         goto end_unlock;
 252                                 }
 253                                 DBG("Kernel consumer get subbuf failed. Skipping it.");
 254                                 consumed_pos += stream->max_sb_size;
 255                                 stream->chan->lost_packets++;
 256                                 continue;
 257                         }
 258
 259                         ret = kernctl_get_subbuf_size(stream->wait_fd, &len);
 260                         if (ret < 0) {
 261                                 ERR("Snapshot kernctl_get_subbuf_size");
 262                                 goto error_put_subbuf;
 263                         }
 264
 265                         ret = kernctl_get_padded_subbuf_size(stream->wait_fd, &padded_len);
 266                         if (ret < 0) {
 267                                 ERR("Snapshot kernctl_get_padded_subbuf_size");
 268                                 goto error_put_subbuf;
 269                         }
 270
 271                         read_len = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, len,
 272                                         padded_len - len, NULL);
 273                         /*
 274                          * We write the padded len in local tracefiles but the data len
 275                          * when using a relay. Display the error but continue processing
 276                          * to try to release the subbuffer.
 277                          */
 278                         if (relayd_id != (uint64_t) -1ULL) {
 279                                 if (read_len != len) {
 280                                         ERR("Error sending to the relay (ret: %zd != len: %lu)",
 281                                                         read_len, len);
 282                                 }
 283                         } else {
 284                                 if (read_len != padded_len) {
 285                                         ERR("Error writing to tracefile (ret: %zd != len: %lu)",
 286                                                         read_len, padded_len);
 287                                 }
 288                         }
 289
 290                         ret = kernctl_put_subbuf(stream->wait_fd);
 291                         if (ret < 0) {
 292                                 ERR("Snapshot kernctl_put_subbuf");
 293                                 goto end_unlock;
 294                         }
 295                         consumed_pos += stream->max_sb_size;
 296                 }
 297
 298                 if (relayd_id == (uint64_t) -1ULL) {
 299                         if (stream->out_fd >= 0) {
 300                                 ret = close(stream->out_fd);
 301                                 if (ret < 0) {
 302                                         PERROR("Kernel consumer snapshot close out_fd");
 303                                         goto end_unlock;
 304                                 }
 305                                 stream->out_fd = -1;
 306                         }
 307                 } else {
 308                         close_relayd_stream(stream);
 309                         stream->net_seq_idx = (uint64_t) -1ULL;
 310                 }
 311                 pthread_mutex_unlock(&stream->lock);
 312         }
 313
 314         /* All good! */
 315         ret = 0;
 316         goto end;
 317
 318 error_put_subbuf:
 319         ret = kernctl_put_subbuf(stream->wait_fd);
 320         if (ret < 0) {
 321                 ERR("Snapshot kernctl_put_subbuf error path");
 322         }
 323 end_unlock:
 324         pthread_mutex_unlock(&stream->lock);
 325 end:
 326         rcu_read_unlock();
 327         return ret;
 328 }
 329
 330 /*
 331  * Read the whole metadata available for a snapshot.
 332  *
 333  * Returns 0 on success, < 0 on error
 334  */
 335 int lttng_kconsumer_snapshot_metadata(uint64_t key, char *path,
 336                 uint64_t relayd_id, struct lttng_consumer_local_data *ctx)
 337 {
 338         int ret, use_relayd = 0;
 339         ssize_t ret_read;
 340         struct lttng_consumer_channel *metadata_channel;
 341         struct lttng_consumer_stream *metadata_stream;
 342
 343         assert(ctx);
 344
 345         DBG("Kernel consumer snapshot metadata with key %" PRIu64 " at path %s",
 346                         key, path);
 347
 348         rcu_read_lock();
 349
 350         metadata_channel = consumer_find_channel(key);
 351         if (!metadata_channel) {
 352                 ERR("Kernel snapshot metadata not found for key %" PRIu64, key);
 353                 ret = -1;
 354                 goto error;
 355         }
 356
 357         metadata_stream = metadata_channel->metadata_stream;
 358         assert(metadata_stream);
 359
 360         /* Flag once that we have a valid relayd for the stream. */
 361         if (relayd_id != (uint64_t) -1ULL) {
 362                 use_relayd = 1;
 363         }
 364
 365         if (use_relayd) {
 366                 ret = consumer_send_relayd_stream(metadata_stream, path);
 367                 if (ret < 0) {
 368                         goto error;
 369                 }
 370         } else {
 371                 ret = utils_create_stream_file(path, metadata_stream->name,
 372                                 metadata_stream->chan->tracefile_size,
 373                                 metadata_stream->tracefile_count_current,
 374                                 metadata_stream->uid, metadata_stream->gid, NULL);
 375                 if (ret < 0) {
 376                         goto error;
 377                 }
 378                 metadata_stream->out_fd = ret;
 379         }
 380
 381         do {
 382                 health_code_update();
 383
 384                 ret_read = lttng_kconsumer_read_subbuffer(metadata_stream, ctx);
 385                 if (ret_read < 0) {
 386                         if (ret_read != -EAGAIN) {
 387                                 ERR("Kernel snapshot reading metadata subbuffer (ret: %zd)",
 388                                                 ret_read);
 389                                 goto error;
 390                         }
 391                         /* ret_read is negative at this point so we will exit the loop. */
 392                         continue;
 393                 }
 394         } while (ret_read >= 0);
 395
 396         if (use_relayd) {
 397                 close_relayd_stream(metadata_stream);
 398                 metadata_stream->net_seq_idx = (uint64_t) -1ULL;
 399         } else {
 400                 if (metadata_stream->out_fd >= 0) {
 401                         ret = close(metadata_stream->out_fd);
 402                         if (ret < 0) {
 403                                 PERROR("Kernel consumer snapshot metadata close out_fd");
 404                                 /*
 405                                  * Don't go on error here since the snapshot was successful at this
 406                                  * point but somehow the close failed.
 407                                  */
 408                         }
 409                         metadata_stream->out_fd = -1;
 410                 }
 411         }
 412
 413         ret = 0;
 414
 415         cds_list_del(&metadata_stream->send_node);
 416         consumer_stream_destroy(metadata_stream, NULL);
 417         metadata_channel->metadata_stream = NULL;
 418 error:
 419         rcu_read_unlock();
 420         return ret;
 421 }
 422
 423 /*
 424  * Receive command from session daemon and process it.
 425  *
 426  * Return 1 on success else a negative value or 0.
 427  */
 428 int lttng_kconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
 429                 int sock, struct pollfd *consumer_sockpoll)
 430 {
 431         ssize_t ret;
 432         enum lttcomm_return_code ret_code = LTTCOMM_CONSUMERD_SUCCESS;
 433         struct lttcomm_consumer_msg msg;
 434
 435         health_code_update();
 436
 437         ret = lttcomm_recv_unix_sock(sock, &msg, sizeof(msg));
 438         if (ret != sizeof(msg)) {
 439                 if (ret > 0) {
 440                         lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD);
 441                         ret = -1;
 442                 }
 443                 return ret;
 444         }
 445
 446         health_code_update();
 447
 448         /* Deprecated command */
 449         assert(msg.cmd_type != LTTNG_CONSUMER_STOP);
 450
 451         health_code_update();
 452
 453         /* relayd needs RCU read-side protection */
 454         rcu_read_lock();
 455
 456         switch (msg.cmd_type) {
 457         case LTTNG_CONSUMER_ADD_RELAYD_SOCKET:
 458         {
 459                 /* Session daemon status message are handled in the following call. */
 460                 consumer_add_relayd_socket(msg.u.relayd_sock.net_index,
 461                                 msg.u.relayd_sock.type, ctx, sock, consumer_sockpoll,
 462                                 &msg.u.relayd_sock.sock, msg.u.relayd_sock.session_id,
 463                                 msg.u.relayd_sock.relayd_session_id);
 464                 goto end_nosignal;
 465         }
 466         case LTTNG_CONSUMER_ADD_CHANNEL:
 467         {
 468                 struct lttng_consumer_channel *new_channel;
 469                 int ret_recv;
 470
 471                 health_code_update();
 472
 473                 /* First send a status message before receiving the fds. */
 474                 ret = consumer_send_status_msg(sock, ret_code);
 475                 if (ret < 0) {
 476                         /* Somehow, the session daemon is not responding anymore. */
 477                         goto error_fatal;
 478                 }
 479
 480                 health_code_update();
 481
 482                 DBG("consumer_add_channel %" PRIu64, msg.u.channel.channel_key);
 483                 new_channel = consumer_allocate_channel(msg.u.channel.channel_key,
 484                                 msg.u.channel.session_id, msg.u.channel.pathname,
 485                                 msg.u.channel.name, msg.u.channel.uid, msg.u.channel.gid,
 486                                 msg.u.channel.relayd_id, msg.u.channel.output,
 487                                 msg.u.channel.tracefile_size,
 488                                 msg.u.channel.tracefile_count, 0,
 489                                 msg.u.channel.monitor,
 490                                 msg.u.channel.live_timer_interval,
 491                                 NULL, NULL);
 492                 if (new_channel == NULL) {
 493                         lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR);
 494                         goto end_nosignal;
 495                 }
 496                 new_channel->nb_init_stream_left = msg.u.channel.nb_init_streams;
 497                 switch (msg.u.channel.output) {
 498                 case LTTNG_EVENT_SPLICE:
 499                         new_channel->output = CONSUMER_CHANNEL_SPLICE;
 500                         break;
 501                 case LTTNG_EVENT_MMAP:
 502                         new_channel->output = CONSUMER_CHANNEL_MMAP;
 503                         break;
 504                 default:
 505                         ERR("Channel output unknown %d", msg.u.channel.output);
 506                         goto end_nosignal;
 507                 }
 508
 509                 /* Translate and save channel type. */
 510                 switch (msg.u.channel.type) {
 511                 case CONSUMER_CHANNEL_TYPE_DATA:
 512                 case CONSUMER_CHANNEL_TYPE_METADATA:
 513                         new_channel->type = msg.u.channel.type;
 514                         break;
 515                 default:
 516                         assert(0);
 517                         goto end_nosignal;
 518                 };
 519
 520                 health_code_update();
 521
 522                 if (ctx->on_recv_channel != NULL) {
 523                         ret_recv = ctx->on_recv_channel(new_channel);
 524                         if (ret_recv == 0) {
 525                                 ret = consumer_add_channel(new_channel, ctx);
 526                         } else if (ret_recv < 0) {
 527                                 goto end_nosignal;
 528                         }
 529                 } else {
 530                         ret = consumer_add_channel(new_channel, ctx);
 531                 }
 532                 if (msg.u.channel.type == CONSUMER_CHANNEL_TYPE_DATA && !ret) {
 533                         int monitor_start_ret;
 534
 535                         DBG("Consumer starting monitor timer");
 536                         consumer_timer_live_start(new_channel,
 537                                         msg.u.channel.live_timer_interval);
 538                         monitor_start_ret = consumer_timer_monitor_start(
 539                                         new_channel,
 540                                         msg.u.channel.monitor_timer_interval);
 541                         if (monitor_start_ret < 0) {
 542                                 ERR("Starting channel monitoring timer failed");
 543                                 goto end_nosignal;
 544                         }
 545
 546                 }
 547
 548                 health_code_update();
 549
 550                 /* If we received an error in add_channel, we need to report it. */
 551                 if (ret < 0) {
 552                         ret = consumer_send_status_msg(sock, ret);
 553                         if (ret < 0) {
 554                                 goto error_fatal;
 555                         }
 556                         goto end_nosignal;
 557                 }
 558
 559                 goto end_nosignal;
 560         }
 561         case LTTNG_CONSUMER_ADD_STREAM:
 562         {
 563                 int fd;
 564                 struct lttng_pipe *stream_pipe;
 565                 struct lttng_consumer_stream *new_stream;
 566                 struct lttng_consumer_channel *channel;
 567                 int alloc_ret = 0;
 568
 569                 /*
 570                  * Get stream's channel reference. Needed when adding the stream to the
 571                  * global hash table.
 572                  */
 573                 channel = consumer_find_channel(msg.u.stream.channel_key);
 574                 if (!channel) {
 575                         /*
 576                          * We could not find the channel. Can happen if cpu hotplug
 577                          * happens while tearing down.
 578                          */
 579                         ERR("Unable to find channel key %" PRIu64, msg.u.stream.channel_key);
 580                         ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND;
 581                 }
 582
 583                 health_code_update();
 584
 585                 /* First send a status message before receiving the fds. */
 586                 ret = consumer_send_status_msg(sock, ret_code);
 587                 if (ret < 0) {
 588                         /* Somehow, the session daemon is not responding anymore. */
 589                         goto error_fatal;
 590                 }
 591
 592                 health_code_update();
 593
 594                 if (ret_code != LTTCOMM_CONSUMERD_SUCCESS) {
 595                         /* Channel was not found. */
 596                         goto end_nosignal;
 597                 }
 598
 599                 /* Blocking call */
 600                 health_poll_entry();
 601                 ret = lttng_consumer_poll_socket(consumer_sockpoll);
 602                 health_poll_exit();
 603                 if (ret) {
 604                         goto error_fatal;
 605                 }
 606
 607                 health_code_update();
 608
 609                 /* Get stream file descriptor from socket */
 610                 ret = lttcomm_recv_fds_unix_sock(sock, &fd, 1);
 611                 if (ret != sizeof(fd)) {
 612                         lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_FD);
 613                         rcu_read_unlock();
 614                         return ret;
 615                 }
 616
 617                 health_code_update();
 618
 619                 /*
 620                  * Send status code to session daemon only if the recv works. If the
 621                  * above recv() failed, the session daemon is notified through the
 622                  * error socket and the teardown is eventually done.
 623                  */
 624                 ret = consumer_send_status_msg(sock, ret_code);
 625                 if (ret < 0) {
 626                         /* Somehow, the session daemon is not responding anymore. */
 627                         goto end_nosignal;
 628                 }
 629
 630                 health_code_update();
 631
 632                 new_stream = consumer_allocate_stream(channel->key,
 633                                 fd,
 634                                 LTTNG_CONSUMER_ACTIVE_STREAM,
 635                                 channel->name,
 636                                 channel->uid,
 637                                 channel->gid,
 638                                 channel->relayd_id,
 639                                 channel->session_id,
 640                                 msg.u.stream.cpu,
 641                                 &alloc_ret,
 642                                 channel->type,
 643                                 channel->monitor);
 644                 if (new_stream == NULL) {
 645                         switch (alloc_ret) {
 646                         case -ENOMEM:
 647                         case -EINVAL:
 648                         default:
 649                                 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR);
 650                                 break;
 651                         }
 652                         goto end_nosignal;
 653                 }
 654
 655                 new_stream->chan = channel;
 656                 new_stream->wait_fd = fd;
 657                 switch (channel->output) {
 658                 case CONSUMER_CHANNEL_SPLICE:
 659                         new_stream->output = LTTNG_EVENT_SPLICE;
 660                         ret = utils_create_pipe(new_stream->splice_pipe);
 661                         if (ret < 0) {
 662                                 goto end_nosignal;
 663                         }
 664                         break;
 665                 case CONSUMER_CHANNEL_MMAP:
 666                         new_stream->output = LTTNG_EVENT_MMAP;
 667                         break;
 668                 default:
 669                         ERR("Stream output unknown %d", channel->output);
 670                         goto end_nosignal;
 671                 }
 672
 673                 /*
 674                  * We've just assigned the channel to the stream so increment the
 675                  * refcount right now. We don't need to increment the refcount for
 676                  * streams in no monitor because we handle manually the cleanup of
 677                  * those. It is very important to make sure there is NO prior
 678                  * consumer_del_stream() calls or else the refcount will be unbalanced.
 679                  */
 680                 if (channel->monitor) {
 681                         uatomic_inc(&new_stream->chan->refcount);
 682                 }
 683
 684                 /*
 685                  * The buffer flush is done on the session daemon side for the kernel
 686                  * so no need for the stream "hangup_flush_done" variable to be
 687                  * tracked. This is important for a kernel stream since we don't rely
 688                  * on the flush state of the stream to read data. It's not the case for
 689                  * user space tracing.
 690                  */
 691                 new_stream->hangup_flush_done = 0;
 692
 693                 health_code_update();
 694
 695                 if (ctx->on_recv_stream) {
 696                         ret = ctx->on_recv_stream(new_stream);
 697                         if (ret < 0) {
 698                                 consumer_stream_free(new_stream);
 699                                 goto end_nosignal;
 700                         }
 701                 }
 702
 703                 health_code_update();
 704
 705                 if (new_stream->metadata_flag) {
 706                         channel->metadata_stream = new_stream;
 707                 }
 708
 709                 /* Do not monitor this stream. */
 710                 if (!channel->monitor) {
 711                         DBG("Kernel consumer add stream %s in no monitor mode with "
 712                                         "relayd id %" PRIu64, new_stream->name,
 713                                         new_stream->net_seq_idx);
 714                         cds_list_add(&new_stream->send_node, &channel->streams.head);
 715                         break;
 716                 }
 717
 718                 /* Send stream to relayd if the stream has an ID. */
 719                 if (new_stream->net_seq_idx != (uint64_t) -1ULL) {
 720                         ret = consumer_send_relayd_stream(new_stream,
 721                                         new_stream->chan->pathname);
 722                         if (ret < 0) {
 723                                 consumer_stream_free(new_stream);
 724                                 goto end_nosignal;
 725                         }
 726
 727                         /*
 728                          * If adding an extra stream to an already
 729                          * existing channel (e.g. cpu hotplug), we need
 730                          * to send the "streams_sent" command to relayd.
 731                          */
 732                         if (channel->streams_sent_to_relayd) {
 733                                 ret = consumer_send_relayd_streams_sent(
 734                                                 new_stream->net_seq_idx);
 735                                 if (ret < 0) {
 736                                         goto end_nosignal;
 737                                 }
 738                         }
 739                 }
 740
 741                 /* Get the right pipe where the stream will be sent. */
 742                 if (new_stream->metadata_flag) {
 743                         consumer_add_metadata_stream(new_stream);
 744                         stream_pipe = ctx->consumer_metadata_pipe;
 745                 } else {
 746                         consumer_add_data_stream(new_stream);
 747                         stream_pipe = ctx->consumer_data_pipe;
 748                 }
 749
 750                 /* Visible to other threads */
 751                 new_stream->globally_visible = 1;
 752
 753                 health_code_update();
 754
 755                 ret = lttng_pipe_write(stream_pipe, &new_stream, sizeof(new_stream));
 756                 if (ret < 0) {
 757                         ERR("Consumer write %s stream to pipe %d",
 758                                         new_stream->metadata_flag ? "metadata" : "data",
 759                                         lttng_pipe_get_writefd(stream_pipe));
 760                         if (new_stream->metadata_flag) {
 761                                 consumer_del_stream_for_metadata(new_stream);
 762                         } else {
 763                                 consumer_del_stream_for_data(new_stream);
 764                         }
 765                         goto end_nosignal;
 766                 }
 767
 768                 DBG("Kernel consumer ADD_STREAM %s (fd: %d) with relayd id %" PRIu64,
 769                                 new_stream->name, fd, new_stream->relayd_stream_id);
 770                 break;
 771         }
 772         case LTTNG_CONSUMER_STREAMS_SENT:
 773         {
 774                 struct lttng_consumer_channel *channel;
 775
 776                 /*
 777                  * Get stream's channel reference. Needed when adding the stream to the
 778                  * global hash table.
 779                  */
 780                 channel = consumer_find_channel(msg.u.sent_streams.channel_key);
 781                 if (!channel) {
 782                         /*
 783                          * We could not find the channel. Can happen if cpu hotplug
 784                          * happens while tearing down.
 785                          */
 786                         ERR("Unable to find channel key %" PRIu64,
 787                                         msg.u.sent_streams.channel_key);
 788                         ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND;
 789                 }
 790
 791                 health_code_update();
 792
 793                 /*
 794                  * Send status code to session daemon.
 795                  */
 796                 ret = consumer_send_status_msg(sock, ret_code);
 797                 if (ret < 0 || ret_code != LTTCOMM_CONSUMERD_SUCCESS) {
 798                         /* Somehow, the session daemon is not responding anymore. */
 799                         goto end_nosignal;
 800                 }
 801
 802                 health_code_update();
 803
 804                 /*
 805                  * We should not send this message if we don't monitor the
 806                  * streams in this channel.
 807                  */
 808                 if (!channel->monitor) {
 809                         break;
 810                 }
 811
 812                 health_code_update();
 813                 /* Send stream to relayd if the stream has an ID. */
 814                 if (msg.u.sent_streams.net_seq_idx != (uint64_t) -1ULL) {
 815                         ret = consumer_send_relayd_streams_sent(
 816                                         msg.u.sent_streams.net_seq_idx);
 817                         if (ret < 0) {
 818                                 goto end_nosignal;
 819                         }
 820                         channel->streams_sent_to_relayd = true;
 821                 }
 822                 break;
 823         }
 824         case LTTNG_CONSUMER_UPDATE_STREAM:
 825         {
 826                 rcu_read_unlock();
 827                 return -ENOSYS;
 828         }
 829         case LTTNG_CONSUMER_DESTROY_RELAYD:
 830         {
 831                 uint64_t index = msg.u.destroy_relayd.net_seq_idx;
 832                 struct consumer_relayd_sock_pair *relayd;
 833
 834                 DBG("Kernel consumer destroying relayd %" PRIu64, index);
 835
 836                 /* Get relayd reference if exists. */
 837                 relayd = consumer_find_relayd(index);
 838                 if (relayd == NULL) {
 839                         DBG("Unable to find relayd %" PRIu64, index);
 840                         ret_code = LTTCOMM_CONSUMERD_RELAYD_FAIL;
 841                 }
 842
 843                 /*
 844                  * Each relayd socket pair has a refcount of stream attached to it
 845                  * which tells if the relayd is still active or not depending on the
 846                  * refcount value.
 847                  *
 848                  * This will set the destroy flag of the relayd object and destroy it
 849                  * if the refcount reaches zero when called.
 850                  *
 851                  * The destroy can happen either here or when a stream fd hangs up.
 852                  */
 853                 if (relayd) {
 854                         consumer_flag_relayd_for_destroy(relayd);
 855                 }
 856
 857                 health_code_update();
 858
 859                 ret = consumer_send_status_msg(sock, ret_code);
 860                 if (ret < 0) {
 861                         /* Somehow, the session daemon is not responding anymore. */
 862                         goto error_fatal;
 863                 }
 864
 865                 goto end_nosignal;
 866         }
 867         case LTTNG_CONSUMER_DATA_PENDING:
 868         {
 869                 int32_t ret;
 870                 uint64_t id = msg.u.data_pending.session_id;
 871
 872                 DBG("Kernel consumer data pending command for id %" PRIu64, id);
 873
 874                 ret = consumer_data_pending(id);
 875
 876                 health_code_update();
 877
 878                 /* Send back returned value to session daemon */
 879                 ret = lttcomm_send_unix_sock(sock, &ret, sizeof(ret));
 880                 if (ret < 0) {
 881                         PERROR("send data pending ret code");
 882                         goto error_fatal;
 883                 }
 884
 885                 /*
 886                  * No need to send back a status message since the data pending
 887                  * returned value is the response.
 888                  */
 889                 break;
 890         }
 891         case LTTNG_CONSUMER_SNAPSHOT_CHANNEL:
 892         {
 893                 if (msg.u.snapshot_channel.metadata == 1) {
 894                         ret = lttng_kconsumer_snapshot_metadata(msg.u.snapshot_channel.key,
 895                                         msg.u.snapshot_channel.pathname,
 896                                         msg.u.snapshot_channel.relayd_id, ctx);
 897                         if (ret < 0) {
 898                                 ERR("Snapshot metadata failed");
 899                                 ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA;
 900                         }
 901                 } else {
 902                         ret = lttng_kconsumer_snapshot_channel(msg.u.snapshot_channel.key,
 903                                         msg.u.snapshot_channel.pathname,
 904                                         msg.u.snapshot_channel.relayd_id,
 905                                         msg.u.snapshot_channel.nb_packets_per_stream,
 906                                         ctx);
 907                         if (ret < 0) {
 908                                 ERR("Snapshot channel failed");
 909                                 ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND;
 910                         }
 911                 }
 912
 913                 health_code_update();
 914
 915                 ret = consumer_send_status_msg(sock, ret_code);
 916                 if (ret < 0) {
 917                         /* Somehow, the session daemon is not responding anymore. */
 918                         goto end_nosignal;
 919                 }
 920                 break;
 921         }
 922         case LTTNG_CONSUMER_DESTROY_CHANNEL:
 923         {
 924                 uint64_t key = msg.u.destroy_channel.key;
 925                 struct lttng_consumer_channel *channel;
 926
 927                 channel = consumer_find_channel(key);
 928                 if (!channel) {
 929                         ERR("Kernel consumer destroy channel %" PRIu64 " not found", key);
 930                         ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND;
 931                 }
 932
 933                 health_code_update();
 934
 935                 ret = consumer_send_status_msg(sock, ret_code);
 936                 if (ret < 0) {
 937                         /* Somehow, the session daemon is not responding anymore. */
 938                         goto end_nosignal;
 939                 }
 940
 941                 health_code_update();
 942
 943                 /* Stop right now if no channel was found. */
 944                 if (!channel) {
 945                         goto end_nosignal;
 946                 }
 947
 948                 /*
 949                  * This command should ONLY be issued for channel with streams set in
 950                  * no monitor mode.
 951                  */
 952                 assert(!channel->monitor);
 953
 954                 /*
 955                  * The refcount should ALWAYS be 0 in the case of a channel in no
 956                  * monitor mode.
 957                  */
 958                 assert(!uatomic_sub_return(&channel->refcount, 1));
 959
 960                 consumer_del_channel(channel);
 961
 962                 goto end_nosignal;
 963         }
 964         case LTTNG_CONSUMER_DISCARDED_EVENTS:
 965         {
 966                 ssize_t ret;
 967                 uint64_t count;
 968                 struct lttng_consumer_channel *channel;
 969                 uint64_t id = msg.u.discarded_events.session_id;
 970                 uint64_t key = msg.u.discarded_events.channel_key;
 971
 972                 DBG("Kernel consumer discarded events command for session id %"
 973                                 PRIu64 ", channel key %" PRIu64, id, key);
 974
 975                 channel = consumer_find_channel(key);
 976                 if (!channel) {
 977                         ERR("Kernel consumer discarded events channel %"
 978                                         PRIu64 " not found", key);
 979                         count = 0;
 980                 } else {
 981                         count = channel->discarded_events;
 982                 }
 983
 984                 health_code_update();
 985
 986                 /* Send back returned value to session daemon */
 987                 ret = lttcomm_send_unix_sock(sock, &count, sizeof(count));
 988                 if (ret < 0) {
 989                         PERROR("send discarded events");
 990                         goto error_fatal;
 991                 }
 992
 993                 break;
 994         }
 995         case LTTNG_CONSUMER_LOST_PACKETS:
 996         {
 997                 ssize_t ret;
 998                 uint64_t count;
 999                 struct lttng_consumer_channel *channel;
1000                 uint64_t id = msg.u.lost_packets.session_id;
1001                 uint64_t key = msg.u.lost_packets.channel_key;
1002
1003                 DBG("Kernel consumer lost packets command for session id %"
1004                                 PRIu64 ", channel key %" PRIu64, id, key);
1005
1006                 channel = consumer_find_channel(key);
1007                 if (!channel) {
1008                         ERR("Kernel consumer lost packets channel %"
1009                                         PRIu64 " not found", key);
1010                         count = 0;
1011                 } else {
1012                         count = channel->lost_packets;
1013                 }
1014
1015                 health_code_update();
1016
1017                 /* Send back returned value to session daemon */
1018                 ret = lttcomm_send_unix_sock(sock, &count, sizeof(count));
1019                 if (ret < 0) {
1020                         PERROR("send lost packets");
1021                         goto error_fatal;
1022                 }
1023
1024                 break;
1025         }
1026         case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE:
1027         {
1028                 int channel_monitor_pipe;
1029
1030                 ret_code = LTTCOMM_CONSUMERD_SUCCESS;
1031                 /* Successfully received the command's type. */
1032                 ret = consumer_send_status_msg(sock, ret_code);
1033                 if (ret < 0) {
1034                         goto error_fatal;
1035                 }
1036
1037                 ret = lttcomm_recv_fds_unix_sock(sock, &channel_monitor_pipe,
1038                                 1);
1039                 if (ret != sizeof(channel_monitor_pipe)) {
1040                         ERR("Failed to receive channel monitor pipe");
1041                         goto error_fatal;
1042                 }
1043
1044                 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe);
1045                 ret = consumer_timer_thread_set_channel_monitor_pipe(
1046                                 channel_monitor_pipe);
1047                 if (!ret) {
1048                         int flags;
1049
1050                         ret_code = LTTCOMM_CONSUMERD_SUCCESS;
1051                         /* Set the pipe as non-blocking. */
1052                         ret = fcntl(channel_monitor_pipe, F_GETFL, 0);
1053                         if (ret == -1) {
1054                                 PERROR("fcntl get flags of the channel monitoring pipe");
1055                                 goto error_fatal;
1056                         }
1057                         flags = ret;
1058
1059                         ret = fcntl(channel_monitor_pipe, F_SETFL,
1060                                         flags | O_NONBLOCK);
1061                         if (ret == -1) {
1062                                 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1063                                 goto error_fatal;
1064                         }
1065                         DBG("Channel monitor pipe set as non-blocking");
1066                 } else {
1067                         ret_code = LTTCOMM_CONSUMERD_ALREADY_SET;
1068                 }
1069                 ret = consumer_send_status_msg(sock, ret_code);
1070                 if (ret < 0) {
1071                         goto error_fatal;
1072                 }
1073                 break;
1074         }
1075         case LTTNG_CONSUMER_MKDIR:
1076         {
1077                 DBG("Consumer mkdir %s in session %" PRIu64,
1078                                 msg.u.mkdir.path,
1079                                 msg.u.mkdir.session_id);
1080                 ret = lttng_consumer_mkdir(msg.u.mkdir.path,
1081                                 msg.u.mkdir.uid,
1082                                 msg.u.mkdir.gid,
1083                                 msg.u.mkdir.relayd_id);
1084                 if (ret < 0) {
1085                         ERR("consumer mkdir failed");
1086                         ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND;
1087                 }
1088
1089                 health_code_update();
1090
1091                 ret = consumer_send_status_msg(sock, ret_code);
1092                 if (ret < 0) {
1093                         /* Somehow, the session daemon is not responding anymore. */
1094                         goto end_nosignal;
1095                 }
1096                 break;
1097         }
1098         default:
1099                 goto end_nosignal;
1100         }
1101
1102 end_nosignal:
1103         rcu_read_unlock();
1104
1105         /*
1106          * Return 1 to indicate success since the 0 value can be a socket
1107          * shutdown during the recv() or send() call.
1108          */
1109         health_code_update();
1110         return 1;
1111
1112 error_fatal:
1113         rcu_read_unlock();
1114         /* This will issue a consumer stop. */
1115         return -1;
1116 }
1117
1118 /*
1119  * Populate index values of a kernel stream. Values are set in big endian order.
1120  *
1121  * Return 0 on success or else a negative value.
1122  */
1123 static int get_index_values(struct ctf_packet_index *index, int infd)
1124 {
1125         int ret;
1126
1127         ret = kernctl_get_timestamp_begin(infd, &index->timestamp_begin);
1128         if (ret < 0) {
1129                 PERROR("kernctl_get_timestamp_begin");
1130                 goto error;
1131         }
1132         index->timestamp_begin = htobe64(index->timestamp_begin);
1133
1134         ret = kernctl_get_timestamp_end(infd, &index->timestamp_end);
1135         if (ret < 0) {
1136                 PERROR("kernctl_get_timestamp_end");
1137                 goto error;
1138         }
1139         index->timestamp_end = htobe64(index->timestamp_end);
1140
1141         ret = kernctl_get_events_discarded(infd, &index->events_discarded);
1142         if (ret < 0) {
1143                 PERROR("kernctl_get_events_discarded");
1144                 goto error;
1145         }
1146         index->events_discarded = htobe64(index->events_discarded);
1147
1148         ret = kernctl_get_content_size(infd, &index->content_size);
1149         if (ret < 0) {
1150                 PERROR("kernctl_get_content_size");
1151                 goto error;
1152         }
1153         index->content_size = htobe64(index->content_size);
1154
1155         ret = kernctl_get_packet_size(infd, &index->packet_size);
1156         if (ret < 0) {
1157                 PERROR("kernctl_get_packet_size");
1158                 goto error;
1159         }
1160         index->packet_size = htobe64(index->packet_size);
1161
1162         ret = kernctl_get_stream_id(infd, &index->stream_id);
1163         if (ret < 0) {
1164                 PERROR("kernctl_get_stream_id");
1165                 goto error;
1166         }
1167         index->stream_id = htobe64(index->stream_id);
1168
1169         ret = kernctl_get_instance_id(infd, &index->stream_instance_id);
1170         if (ret < 0) {
1171                 if (ret == -ENOTTY) {
1172                         /* Command not implemented by lttng-modules. */
1173                         index->stream_instance_id = -1ULL;
1174                 } else {
1175                         PERROR("kernctl_get_instance_id");
1176                         goto error;
1177                 }
1178         }
1179         index->stream_instance_id = htobe64(index->stream_instance_id);
1180
1181         ret = kernctl_get_sequence_number(infd, &index->packet_seq_num);
1182         if (ret < 0) {
1183                 if (ret == -ENOTTY) {
1184                         /* Command not implemented by lttng-modules. */
1185                         index->packet_seq_num = -1ULL;
1186                         ret = 0;
1187                 } else {
1188                         PERROR("kernctl_get_sequence_number");
1189                         goto error;
1190                 }
1191         }
1192         index->packet_seq_num = htobe64(index->packet_seq_num);
1193
1194 error:
1195         return ret;
1196 }
1197 /*
1198  * Sync metadata meaning request them to the session daemon and snapshot to the
1199  * metadata thread can consumer them.
1200  *
1201  * Metadata stream lock MUST be acquired.
1202  *
1203  * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1204  * is empty or a negative value on error.
1205  */
1206 int lttng_kconsumer_sync_metadata(struct lttng_consumer_stream *metadata)
1207 {
1208         int ret;
1209
1210         assert(metadata);
1211
1212         ret = kernctl_buffer_flush(metadata->wait_fd);
1213         if (ret < 0) {
1214                 ERR("Failed to flush kernel stream");
1215                 goto end;
1216         }
1217
1218         ret = kernctl_snapshot(metadata->wait_fd);
1219         if (ret < 0) {
1220                 if (ret != -EAGAIN) {
1221                         ERR("Sync metadata, taking kernel snapshot failed.");
1222                         goto end;
1223                 }
1224                 DBG("Sync metadata, no new kernel metadata");
1225                 /* No new metadata, exit. */
1226                 ret = ENODATA;
1227                 goto end;
1228         }
1229
1230 end:
1231         return ret;
1232 }
1233
1234 static
1235 int update_stream_stats(struct lttng_consumer_stream *stream)
1236 {
1237         int ret;
1238         uint64_t seq, discarded;
1239
1240         ret = kernctl_get_sequence_number(stream->wait_fd, &seq);
1241         if (ret < 0) {
1242                 if (ret == -ENOTTY) {
1243                         /* Command not implemented by lttng-modules. */
1244                         seq = -1ULL;
1245                 } else {
1246                         PERROR("kernctl_get_sequence_number");
1247                         goto end;
1248                 }
1249         }
1250
1251         /*
1252          * Start the sequence when we extract the first packet in case we don't
1253          * start at 0 (for example if a consumer is not connected to the
1254          * session immediately after the beginning).
1255          */
1256         if (stream->last_sequence_number == -1ULL) {
1257                 stream->last_sequence_number = seq;
1258         } else if (seq > stream->last_sequence_number) {
1259                 stream->chan->lost_packets += seq -
1260                                 stream->last_sequence_number - 1;
1261         } else {
1262                 /* seq <= last_sequence_number */
1263                 ERR("Sequence number inconsistent : prev = %" PRIu64
1264                                 ", current = %" PRIu64,
1265                                 stream->last_sequence_number, seq);
1266                 ret = -1;
1267                 goto end;
1268         }
1269         stream->last_sequence_number = seq;
1270
1271         ret = kernctl_get_events_discarded(stream->wait_fd, &discarded);
1272         if (ret < 0) {
1273                 PERROR("kernctl_get_events_discarded");
1274                 goto end;
1275         }
1276         if (discarded < stream->last_discarded_events) {
1277                 /*
1278                  * Overflow has occurred. We assume only one wrap-around
1279                  * has occurred.
1280                  */
1281                 stream->chan->discarded_events += (1ULL << (CAA_BITS_PER_LONG - 1)) -
1282                         stream->last_discarded_events + discarded;
1283         } else {
1284                 stream->chan->discarded_events += discarded -
1285                         stream->last_discarded_events;
1286         }
1287         stream->last_discarded_events = discarded;
1288         ret = 0;
1289
1290 end:
1291         return ret;
1292 }
1293
1294 /*
1295  * Check if the local version of the metadata stream matches with the version
1296  * of the metadata stream in the kernel. If it was updated, set the reset flag
1297  * on the stream.
1298  */
1299 static
1300 int metadata_stream_check_version(int infd, struct lttng_consumer_stream *stream)
1301 {
1302         int ret;
1303         uint64_t cur_version;
1304
1305         ret = kernctl_get_metadata_version(infd, &cur_version);
1306         if (ret < 0) {
1307                 if (ret == -ENOTTY) {
1308                         /*
1309                          * LTTng-modules does not implement this
1310                          * command.
1311                          */
1312                         ret = 0;
1313                         goto end;
1314                 }
1315                 ERR("Failed to get the metadata version");
1316                 goto end;
1317         }
1318
1319         if (stream->metadata_version == cur_version) {
1320                 ret = 0;
1321                 goto end;
1322         }
1323
1324         DBG("New metadata version detected");
1325         stream->metadata_version = cur_version;
1326         stream->reset_metadata_flag = 1;
1327         ret = 0;
1328
1329 end:
1330         return ret;
1331 }
1332
1333 /*
1334  * Consume data on a file descriptor and write it on a trace file.
1335  */
1336 ssize_t lttng_kconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
1337                 struct lttng_consumer_local_data *ctx)
1338 {
1339         unsigned long len, subbuf_size, padding;
1340         int err, write_index = 1;
1341         ssize_t ret = 0;
1342         int infd = stream->wait_fd;
1343         struct ctf_packet_index index;
1344
1345         DBG("In read_subbuffer (infd : %d)", infd);
1346
1347         /* Get the next subbuffer */
1348         err = kernctl_get_next_subbuf(infd);
1349         if (err != 0) {
1350                 /*
1351                  * This is a debug message even for single-threaded consumer,
1352                  * because poll() have more relaxed criterions than get subbuf,
1353                  * so get_subbuf may fail for short race windows where poll()
1354                  * would issue wakeups.
1355                  */
1356                 DBG("Reserving sub buffer failed (everything is normal, "
1357                                 "it is due to concurrency)");
1358                 ret = err;
1359                 goto end;
1360         }
1361
1362         /* Get the full subbuffer size including padding */
1363         err = kernctl_get_padded_subbuf_size(infd, &len);
1364         if (err != 0) {
1365                 PERROR("Getting sub-buffer len failed.");
1366                 err = kernctl_put_subbuf(infd);
1367                 if (err != 0) {
1368                         if (err == -EFAULT) {
1369                                 PERROR("Error in unreserving sub buffer\n");
1370                         } else if (err == -EIO) {
1371                                 /* Should never happen with newer LTTng versions */
1372                                 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1373                         }
1374                         ret = err;
1375                         goto end;
1376                 }
1377                 ret = err;
1378                 goto end;
1379         }
1380
1381         if (!stream->metadata_flag) {
1382                 ret = get_index_values(&index, infd);
1383                 if (ret < 0) {
1384                         err = kernctl_put_subbuf(infd);
1385                         if (err != 0) {
1386                                 if (err == -EFAULT) {
1387                                         PERROR("Error in unreserving sub buffer\n");
1388                                 } else if (err == -EIO) {
1389                                         /* Should never happen with newer LTTng versions */
1390                                         PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1391                                 }
1392                                 ret = err;
1393                                 goto end;
1394                         }
1395                         goto end;
1396                 }
1397                 ret = update_stream_stats(stream);
1398                 if (ret < 0) {
1399                         err = kernctl_put_subbuf(infd);
1400                         if (err != 0) {
1401                                 if (err == -EFAULT) {
1402                                         PERROR("Error in unreserving sub buffer\n");
1403                                 } else if (err == -EIO) {
1404                                         /* Should never happen with newer LTTng versions */
1405                                         PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1406                                 }
1407                                 ret = err;
1408                                 goto end;
1409                         }
1410                         goto end;
1411                 }
1412         } else {
1413                 write_index = 0;
1414                 ret = metadata_stream_check_version(infd, stream);
1415                 if (ret < 0) {
1416                         err = kernctl_put_subbuf(infd);
1417                         if (err != 0) {
1418                                 if (err == -EFAULT) {
1419                                         PERROR("Error in unreserving sub buffer\n");
1420                                 } else if (err == -EIO) {
1421                                         /* Should never happen with newer LTTng versions */
1422                                         PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1423                                 }
1424                                 ret = err;
1425                                 goto end;
1426                         }
1427                         goto end;
1428                 }
1429         }
1430
1431         switch (stream->chan->output) {
1432         case CONSUMER_CHANNEL_SPLICE:
1433                 /*
1434                  * XXX: The lttng-modules splice "actor" does not handle copying
1435                  * partial pages hence only using the subbuffer size without the
1436                  * padding makes the splice fail.
1437                  */
1438                 subbuf_size = len;
1439                 padding = 0;
1440
1441                 /* splice the subbuffer to the tracefile */
1442                 ret = lttng_consumer_on_read_subbuffer_splice(ctx, stream, subbuf_size,
1443                                 padding, &index);
1444                 /*
1445                  * XXX: Splice does not support network streaming so the return value
1446                  * is simply checked against subbuf_size and not like the mmap() op.
1447                  */
1448                 if (ret != subbuf_size) {
1449                         /*
1450                          * display the error but continue processing to try
1451                          * to release the subbuffer
1452                          */
1453                         ERR("Error splicing to tracefile (ret: %zd != len: %lu)",
1454                                         ret, subbuf_size);
1455                         write_index = 0;
1456                 }
1457                 break;
1458         case CONSUMER_CHANNEL_MMAP:
1459                 /* Get subbuffer size without padding */
1460                 err = kernctl_get_subbuf_size(infd, &subbuf_size);
1461                 if (err != 0) {
1462                         PERROR("Getting sub-buffer len failed.");
1463                         err = kernctl_put_subbuf(infd);
1464                         if (err != 0) {
1465                                 if (err == -EFAULT) {
1466                                         PERROR("Error in unreserving sub buffer\n");
1467                                 } else if (err == -EIO) {
1468                                         /* Should never happen with newer LTTng versions */
1469                                         PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1470                                 }
1471                                 ret = err;
1472                                 goto end;
1473                         }
1474                         ret = err;
1475                         goto end;
1476                 }
1477
1478                 /* Make sure the tracer is not gone mad on us! */
1479                 assert(len >= subbuf_size);
1480
1481                 padding = len - subbuf_size;
1482
1483                 /* write the subbuffer to the tracefile */
1484                 ret = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, subbuf_size,
1485                                 padding, &index);
1486                 /*
1487                  * The mmap operation should write subbuf_size amount of data when
1488                  * network streaming or the full padding (len) size when we are _not_
1489                  * streaming.
1490                  */
1491                 if ((ret != subbuf_size && stream->net_seq_idx != (uint64_t) -1ULL) ||
1492                                 (ret != len && stream->net_seq_idx == (uint64_t) -1ULL)) {
1493                         /*
1494                          * Display the error but continue processing to try to release the
1495                          * subbuffer. This is a DBG statement since this is possible to
1496                          * happen without being a critical error.
1497                          */
1498                         DBG("Error writing to tracefile "
1499                                         "(ret: %zd != len: %lu != subbuf_size: %lu)",
1500                                         ret, len, subbuf_size);
1501                         write_index = 0;
1502                 }
1503                 break;
1504         default:
1505                 ERR("Unknown output method");
1506                 ret = -EPERM;
1507         }
1508
1509         err = kernctl_put_next_subbuf(infd);
1510         if (err != 0) {
1511                 if (err == -EFAULT) {
1512                         PERROR("Error in unreserving sub buffer\n");
1513                 } else if (err == -EIO) {
1514                         /* Should never happen with newer LTTng versions */
1515                         PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1516                 }
1517                 ret = err;
1518                 goto end;
1519         }
1520
1521         /* Write index if needed. */
1522         if (!write_index) {
1523                 goto end;
1524         }
1525
1526         if (stream->chan->live_timer_interval && !stream->metadata_flag) {
1527                 /*
1528                  * In live, block until all the metadata is sent.
1529                  */
1530                 pthread_mutex_lock(&stream->metadata_timer_lock);
1531                 assert(!stream->missed_metadata_flush);
1532                 stream->waiting_on_metadata = true;
1533                 pthread_mutex_unlock(&stream->metadata_timer_lock);
1534
1535                 err = consumer_stream_sync_metadata(ctx, stream->session_id);
1536
1537                 pthread_mutex_lock(&stream->metadata_timer_lock);
1538                 stream->waiting_on_metadata = false;
1539                 if (stream->missed_metadata_flush) {
1540                         stream->missed_metadata_flush = false;
1541                         pthread_mutex_unlock(&stream->metadata_timer_lock);
1542                         (void) consumer_flush_kernel_index(stream);
1543                 } else {
1544                         pthread_mutex_unlock(&stream->metadata_timer_lock);
1545                 }
1546                 if (err < 0) {
1547                         goto end;
1548                 }
1549         }
1550
1551         err = consumer_stream_write_index(stream, &index);
1552         if (err < 0) {
1553                 goto end;
1554         }
1555
1556 end:
1557         return ret;
1558 }
1559
1560 int lttng_kconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
1561 {
1562         int ret;
1563
1564         assert(stream);
1565
1566         /*
1567          * Don't create anything if this is set for streaming or should not be
1568          * monitored.
1569          */
1570         if (stream->net_seq_idx == (uint64_t) -1ULL && stream->chan->monitor) {
1571                 ret = utils_create_stream_file(stream->chan->pathname, stream->name,
1572                                 stream->chan->tracefile_size, stream->tracefile_count_current,
1573                                 stream->uid, stream->gid, NULL);
1574                 if (ret < 0) {
1575                         goto error;
1576                 }
1577                 stream->out_fd = ret;
1578                 stream->tracefile_size_current = 0;
1579
1580                 if (!stream->metadata_flag) {
1581                         struct lttng_index_file *index_file;
1582
1583                         index_file = lttng_index_file_create(stream->chan->pathname,
1584                                         stream->name, stream->uid, stream->gid,
1585                                         stream->chan->tracefile_size,
1586                                         stream->tracefile_count_current,
1587                                         CTF_INDEX_MAJOR, CTF_INDEX_MINOR);
1588                         if (!index_file) {
1589                                 goto error;
1590                         }
1591                         assert(!stream->index_file);
1592                         stream->index_file = index_file;
1593                 }
1594         }
1595
1596         if (stream->output == LTTNG_EVENT_MMAP) {
1597                 /* get the len of the mmap region */
1598                 unsigned long mmap_len;
1599
1600                 ret = kernctl_get_mmap_len(stream->wait_fd, &mmap_len);
1601                 if (ret != 0) {
1602                         PERROR("kernctl_get_mmap_len");
1603                         goto error_close_fd;
1604                 }
1605                 stream->mmap_len = (size_t) mmap_len;
1606
1607                 stream->mmap_base = mmap(NULL, stream->mmap_len, PROT_READ,
1608                                 MAP_PRIVATE, stream->wait_fd, 0);
1609                 if (stream->mmap_base == MAP_FAILED) {
1610                         PERROR("Error mmaping");
1611                         ret = -1;
1612                         goto error_close_fd;
1613                 }
1614         }
1615
1616         /* we return 0 to let the library handle the FD internally */
1617         return 0;
1618
1619 error_close_fd:
1620         if (stream->out_fd >= 0) {
1621                 int err;
1622
1623                 err = close(stream->out_fd);
1624                 assert(!err);
1625                 stream->out_fd = -1;
1626         }
1627 error:
1628         return ret;
1629 }
1630
1631 /*
1632  * Check if data is still being extracted from the buffers for a specific
1633  * stream. Consumer data lock MUST be acquired before calling this function
1634  * and the stream lock.
1635  *
1636  * Return 1 if the traced data are still getting read else 0 meaning that the
1637  * data is available for trace viewer reading.
1638  */
1639 int lttng_kconsumer_data_pending(struct lttng_consumer_stream *stream)
1640 {
1641         int ret;
1642
1643         assert(stream);
1644
1645         if (stream->endpoint_status != CONSUMER_ENDPOINT_ACTIVE) {
1646                 ret = 0;
1647                 goto end;
1648         }
1649
1650         ret = kernctl_get_next_subbuf(stream->wait_fd);
1651         if (ret == 0) {
1652                 /* There is still data so let's put back this subbuffer. */
1653                 ret = kernctl_put_subbuf(stream->wait_fd);
1654                 assert(ret == 0);
1655                 ret = 1;   /* Data is pending */
1656                 goto end;
1657         }
1658
1659         /* Data is NOT pending and ready to be read. */
1660         ret = 0;
1661
1662 end:
1663         return ret;
1664 }