liblttng-ust-ctl/ustctl.c

   1 /*
   2  * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
   3  * Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; version 2 of the License only.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <string.h>
  21 #include <lttng/ust-ctl.h>
  22 #include <lttng/ust-abi.h>
  23 #include <lttng/ust-events.h>
  24 #include <sys/mman.h>
  25 #include <byteswap.h>
  26
  27 #include <usterr-signal-safe.h>
  28 #include <ust-comm.h>
  29 #include <helper.h>
  30
  31 #include "../libringbuffer/backend.h"
  32 #include "../libringbuffer/frontend.h"
  33 #include "../liblttng-ust/wait.h"
  34 #include "../liblttng-ust/lttng-rb-clients.h"
  35
  36 /*
  37  * Number of milliseconds to retry before failing metadata writes on
  38  * buffer full condition. (10 seconds)
  39  */
  40 #define LTTNG_METADATA_TIMEOUT_MSEC     10000
  41
  42 /*
  43  * Channel representation within consumer.
  44  */
  45 struct ustctl_consumer_channel {
  46         struct lttng_channel *chan;             /* lttng channel buffers */
  47
  48         /* initial attributes */
  49         struct ustctl_consumer_channel_attr attr;
  50         int wait_fd;                            /* monitor close() */
  51         int wakeup_fd;                          /* monitor close() */
  52 };
  53
  54 /*
  55  * Stream representation within consumer.
  56  */
  57 struct ustctl_consumer_stream {
  58         struct lttng_ust_shm_handle *handle;    /* shared-memory handle */
  59         struct lttng_ust_lib_ring_buffer *buf;
  60         struct ustctl_consumer_channel *chan;
  61         int shm_fd, wait_fd, wakeup_fd;
  62         int cpu;
  63         uint64_t memory_map_size;
  64 };
  65
  66 extern void lttng_ring_buffer_client_overwrite_init(void);
  67 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
  68 extern void lttng_ring_buffer_client_discard_init(void);
  69 extern void lttng_ring_buffer_client_discard_rt_init(void);
  70 extern void lttng_ring_buffer_metadata_client_init(void);
  71 extern void lttng_ring_buffer_client_overwrite_exit(void);
  72 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
  73 extern void lttng_ring_buffer_client_discard_exit(void);
  74 extern void lttng_ring_buffer_client_discard_rt_exit(void);
  75 extern void lttng_ring_buffer_metadata_client_exit(void);
  76
  77 volatile enum ust_loglevel ust_loglevel;
  78
  79 int ustctl_release_handle(int sock, int handle)
  80 {
  81         struct ustcomm_ust_msg lum;
  82         struct ustcomm_ust_reply lur;
  83
  84         if (sock < 0 || handle < 0)
  85                 return 0;
  86         memset(&lum, 0, sizeof(lum));
  87         lum.handle = handle;
  88         lum.cmd = LTTNG_UST_RELEASE;
  89         return ustcomm_send_app_cmd(sock, &lum, &lur);
  90 }
  91
  92 /*
  93  * If sock is negative, it means we don't have to notify the other side
  94  * (e.g. application has already vanished).
  95  */
  96 int ustctl_release_object(int sock, struct lttng_ust_object_data *data)
  97 {
  98         int ret;
  99
 100         if (!data)
 101                 return -EINVAL;
 102
 103         switch (data->type) {
 104         case LTTNG_UST_OBJECT_TYPE_CHANNEL:
 105                 if (data->u.channel.wakeup_fd >= 0) {
 106                         ret = close(data->u.channel.wakeup_fd);
 107                         if (ret < 0) {
 108                                 ret = -errno;
 109                                 return ret;
 110                         }
 111                 }
 112                 free(data->u.channel.data);
 113                 break;
 114         case LTTNG_UST_OBJECT_TYPE_STREAM:
 115                 if (data->u.stream.shm_fd >= 0) {
 116                         ret = close(data->u.stream.shm_fd);
 117                         if (ret < 0) {
 118                                 ret = -errno;
 119                                 return ret;
 120                         }
 121                 }
 122                 if (data->u.stream.wakeup_fd >= 0) {
 123                         ret = close(data->u.stream.wakeup_fd);
 124                         if (ret < 0) {
 125                                 ret = -errno;
 126                                 return ret;
 127                         }
 128                 }
 129                 break;
 130         case LTTNG_UST_OBJECT_TYPE_EVENT:
 131         case LTTNG_UST_OBJECT_TYPE_CONTEXT:
 132                 break;
 133         default:
 134                 assert(0);
 135         }
 136         return ustctl_release_handle(sock, data->handle);
 137 }
 138
 139 /*
 140  * Send registration done packet to the application.
 141  */
 142 int ustctl_register_done(int sock)
 143 {
 144         struct ustcomm_ust_msg lum;
 145         struct ustcomm_ust_reply lur;
 146         int ret;
 147
 148         DBG("Sending register done command to %d", sock);
 149         memset(&lum, 0, sizeof(lum));
 150         lum.handle = LTTNG_UST_ROOT_HANDLE;
 151         lum.cmd = LTTNG_UST_REGISTER_DONE;
 152         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 153         if (ret)
 154                 return ret;
 155         return 0;
 156 }
 157
 158 /*
 159  * returns session handle.
 160  */
 161 int ustctl_create_session(int sock)
 162 {
 163         struct ustcomm_ust_msg lum;
 164         struct ustcomm_ust_reply lur;
 165         int ret, session_handle;
 166
 167         /* Create session */
 168         memset(&lum, 0, sizeof(lum));
 169         lum.handle = LTTNG_UST_ROOT_HANDLE;
 170         lum.cmd = LTTNG_UST_SESSION;
 171         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 172         if (ret)
 173                 return ret;
 174         session_handle = lur.ret_val;
 175         DBG("received session handle %u", session_handle);
 176         return session_handle;
 177 }
 178
 179 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
 180                 struct lttng_ust_object_data *channel_data,
 181                 struct lttng_ust_object_data **_event_data)
 182 {
 183         struct ustcomm_ust_msg lum;
 184         struct ustcomm_ust_reply lur;
 185         struct lttng_ust_object_data *event_data;
 186         int ret;
 187
 188         if (!channel_data || !_event_data)
 189                 return -EINVAL;
 190
 191         event_data = zmalloc(sizeof(*event_data));
 192         if (!event_data)
 193                 return -ENOMEM;
 194         event_data->type = LTTNG_UST_OBJECT_TYPE_EVENT;
 195         memset(&lum, 0, sizeof(lum));
 196         lum.handle = channel_data->handle;
 197         lum.cmd = LTTNG_UST_EVENT;
 198         strncpy(lum.u.event.name, ev->name,
 199                 LTTNG_UST_SYM_NAME_LEN);
 200         lum.u.event.instrumentation = ev->instrumentation;
 201         lum.u.event.loglevel_type = ev->loglevel_type;
 202         lum.u.event.loglevel = ev->loglevel;
 203         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 204         if (ret) {
 205                 free(event_data);
 206                 return ret;
 207         }
 208         event_data->handle = lur.ret_val;
 209         DBG("received event handle %u", event_data->handle);
 210         *_event_data = event_data;
 211         return 0;
 212 }
 213
 214 int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
 215                 struct lttng_ust_object_data *obj_data,
 216                 struct lttng_ust_object_data **_context_data)
 217 {
 218         struct ustcomm_ust_msg lum;
 219         struct ustcomm_ust_reply lur;
 220         struct lttng_ust_object_data *context_data;
 221         int ret;
 222
 223         if (!obj_data || !_context_data)
 224                 return -EINVAL;
 225
 226         context_data = zmalloc(sizeof(*context_data));
 227         if (!context_data)
 228                 return -ENOMEM;
 229         context_data->type = LTTNG_UST_OBJECT_TYPE_CONTEXT;
 230         memset(&lum, 0, sizeof(lum));
 231         lum.handle = obj_data->handle;
 232         lum.cmd = LTTNG_UST_CONTEXT;
 233         lum.u.context.ctx = ctx->ctx;
 234         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 235         if (ret) {
 236                 free(context_data);
 237                 return ret;
 238         }
 239         context_data->handle = -1;
 240         DBG("Context created successfully");
 241         *_context_data = context_data;
 242         return ret;
 243 }
 244
 245 int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
 246                 struct lttng_ust_object_data *obj_data)
 247 {
 248         struct ustcomm_ust_msg lum;
 249         struct ustcomm_ust_reply lur;
 250         int ret;
 251
 252         if (!obj_data)
 253                 return -EINVAL;
 254
 255         memset(&lum, 0, sizeof(lum));
 256         lum.handle = obj_data->handle;
 257         lum.cmd = LTTNG_UST_FILTER;
 258         lum.u.filter.data_size = bytecode->len;
 259         lum.u.filter.reloc_offset = bytecode->reloc_offset;
 260         lum.u.filter.seqnum = bytecode->seqnum;
 261
 262         ret = ustcomm_send_app_msg(sock, &lum);
 263         if (ret)
 264                 return ret;
 265         /* send var len bytecode */
 266         ret = ustcomm_send_unix_sock(sock, bytecode->data,
 267                                 bytecode->len);
 268         if (ret < 0) {
 269                 return ret;
 270         }
 271         if (ret != bytecode->len)
 272                 return -EINVAL;
 273         return ustcomm_recv_app_reply(sock, &lur, lum.handle, lum.cmd);
 274 }
 275
 276 int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion,
 277                 struct lttng_ust_object_data *obj_data)
 278 {
 279         struct ustcomm_ust_msg lum;
 280         struct ustcomm_ust_reply lur;
 281         int ret;
 282
 283         if (!obj_data) {
 284                 return -EINVAL;
 285         }
 286
 287         memset(&lum, 0, sizeof(lum));
 288         lum.handle = obj_data->handle;
 289         lum.cmd = LTTNG_UST_EXCLUSION;
 290         lum.u.exclusion.count = exclusion->count;
 291
 292         ret = ustcomm_send_app_msg(sock, &lum);
 293         if (ret) {
 294                 return ret;
 295         }
 296
 297         /* send var len bytecode */
 298         ret = ustcomm_send_unix_sock(sock,
 299                         exclusion->names,
 300                         exclusion->count * LTTNG_UST_SYM_NAME_LEN);
 301         if (ret < 0) {
 302                 return ret;
 303         }
 304         if (ret != exclusion->count * LTTNG_UST_SYM_NAME_LEN) {
 305                 return -EINVAL;
 306         }
 307         return ustcomm_recv_app_reply(sock, &lur, lum.handle, lum.cmd);
 308 }
 309
 310 /* Enable event, channel and session ioctl */
 311 int ustctl_enable(int sock, struct lttng_ust_object_data *object)
 312 {
 313         struct ustcomm_ust_msg lum;
 314         struct ustcomm_ust_reply lur;
 315         int ret;
 316
 317         if (!object)
 318                 return -EINVAL;
 319
 320         memset(&lum, 0, sizeof(lum));
 321         lum.handle = object->handle;
 322         lum.cmd = LTTNG_UST_ENABLE;
 323         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 324         if (ret)
 325                 return ret;
 326         DBG("enabled handle %u", object->handle);
 327         return 0;
 328 }
 329
 330 /* Disable event, channel and session ioctl */
 331 int ustctl_disable(int sock, struct lttng_ust_object_data *object)
 332 {
 333         struct ustcomm_ust_msg lum;
 334         struct ustcomm_ust_reply lur;
 335         int ret;
 336
 337         if (!object)
 338                 return -EINVAL;
 339
 340         memset(&lum, 0, sizeof(lum));
 341         lum.handle = object->handle;
 342         lum.cmd = LTTNG_UST_DISABLE;
 343         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 344         if (ret)
 345                 return ret;
 346         DBG("disable handle %u", object->handle);
 347         return 0;
 348 }
 349
 350 int ustctl_start_session(int sock, int handle)
 351 {
 352         struct lttng_ust_object_data obj;
 353
 354         obj.handle = handle;
 355         return ustctl_enable(sock, &obj);
 356 }
 357
 358 int ustctl_stop_session(int sock, int handle)
 359 {
 360         struct lttng_ust_object_data obj;
 361
 362         obj.handle = handle;
 363         return ustctl_disable(sock, &obj);
 364 }
 365
 366 int ustctl_tracepoint_list(int sock)
 367 {
 368         struct ustcomm_ust_msg lum;
 369         struct ustcomm_ust_reply lur;
 370         int ret, tp_list_handle;
 371
 372         memset(&lum, 0, sizeof(lum));
 373         lum.handle = LTTNG_UST_ROOT_HANDLE;
 374         lum.cmd = LTTNG_UST_TRACEPOINT_LIST;
 375         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 376         if (ret)
 377                 return ret;
 378         tp_list_handle = lur.ret_val;
 379         DBG("received tracepoint list handle %u", tp_list_handle);
 380         return tp_list_handle;
 381 }
 382
 383 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
 384                 struct lttng_ust_tracepoint_iter *iter)
 385 {
 386         struct ustcomm_ust_msg lum;
 387         struct ustcomm_ust_reply lur;
 388         int ret;
 389
 390         if (!iter)
 391                 return -EINVAL;
 392
 393         memset(&lum, 0, sizeof(lum));
 394         lum.handle = tp_list_handle;
 395         lum.cmd = LTTNG_UST_TRACEPOINT_LIST_GET;
 396         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 397         if (ret)
 398                 return ret;
 399         DBG("received tracepoint list entry name %s loglevel %d",
 400                 lur.u.tracepoint.name,
 401                 lur.u.tracepoint.loglevel);
 402         memcpy(iter, &lur.u.tracepoint, sizeof(*iter));
 403         return 0;
 404 }
 405
 406 int ustctl_tracepoint_field_list(int sock)
 407 {
 408         struct ustcomm_ust_msg lum;
 409         struct ustcomm_ust_reply lur;
 410         int ret, tp_field_list_handle;
 411
 412         memset(&lum, 0, sizeof(lum));
 413         lum.handle = LTTNG_UST_ROOT_HANDLE;
 414         lum.cmd = LTTNG_UST_TRACEPOINT_FIELD_LIST;
 415         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 416         if (ret)
 417                 return ret;
 418         tp_field_list_handle = lur.ret_val;
 419         DBG("received tracepoint field list handle %u", tp_field_list_handle);
 420         return tp_field_list_handle;
 421 }
 422
 423 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 424                 struct lttng_ust_field_iter *iter)
 425 {
 426         struct ustcomm_ust_msg lum;
 427         struct ustcomm_ust_reply lur;
 428         int ret;
 429         ssize_t len;
 430
 431         if (!iter)
 432                 return -EINVAL;
 433
 434         memset(&lum, 0, sizeof(lum));
 435         lum.handle = tp_field_list_handle;
 436         lum.cmd = LTTNG_UST_TRACEPOINT_FIELD_LIST_GET;
 437         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 438         if (ret)
 439                 return ret;
 440         len = ustcomm_recv_unix_sock(sock, iter, sizeof(*iter));
 441         if (len != sizeof(*iter)) {
 442                 return -EINVAL;
 443         }
 444         DBG("received tracepoint field list entry event_name %s event_loglevel %d field_name %s field_type %d",
 445                 iter->event_name,
 446                 iter->loglevel,
 447                 iter->field_name,
 448                 iter->type);
 449         return 0;
 450 }
 451
 452 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v)
 453 {
 454         struct ustcomm_ust_msg lum;
 455         struct ustcomm_ust_reply lur;
 456         int ret;
 457
 458         if (!v)
 459                 return -EINVAL;
 460
 461         memset(&lum, 0, sizeof(lum));
 462         lum.handle = LTTNG_UST_ROOT_HANDLE;
 463         lum.cmd = LTTNG_UST_TRACER_VERSION;
 464         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 465         if (ret)
 466                 return ret;
 467         memcpy(v, &lur.u.version, sizeof(*v));
 468         DBG("received tracer version");
 469         return 0;
 470 }
 471
 472 int ustctl_wait_quiescent(int sock)
 473 {
 474         struct ustcomm_ust_msg lum;
 475         struct ustcomm_ust_reply lur;
 476         int ret;
 477
 478         memset(&lum, 0, sizeof(lum));
 479         lum.handle = LTTNG_UST_ROOT_HANDLE;
 480         lum.cmd = LTTNG_UST_WAIT_QUIESCENT;
 481         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 482         if (ret)
 483                 return ret;
 484         DBG("waited for quiescent state");
 485         return 0;
 486 }
 487
 488 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate)
 489 {
 490         if (!calibrate)
 491                 return -EINVAL;
 492
 493         return -ENOSYS;
 494 }
 495
 496 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object)
 497 {
 498         struct ustcomm_ust_msg lum;
 499         struct ustcomm_ust_reply lur;
 500         int ret;
 501
 502         if (!object)
 503                 return -EINVAL;
 504
 505         memset(&lum, 0, sizeof(lum));
 506         lum.handle = object->handle;
 507         lum.cmd = LTTNG_UST_FLUSH_BUFFER;
 508         ret = ustcomm_send_app_cmd(sock, &lum, &lur);
 509         if (ret)
 510                 return ret;
 511         DBG("flushed buffer handle %u", object->handle);
 512         return 0;
 513 }
 514
 515 static
 516 int ustctl_send_channel(int sock,
 517                 enum lttng_ust_chan_type type,
 518                 void *data,
 519                 uint64_t size,
 520                 int wakeup_fd,
 521                 int send_fd_only)
 522 {
 523         ssize_t len;
 524
 525         if (!send_fd_only) {
 526                 /* Send mmap size */
 527                 len = ustcomm_send_unix_sock(sock, &size, sizeof(size));
 528                 if (len != sizeof(size)) {
 529                         if (len < 0)
 530                                 return len;
 531                         else
 532                                 return -EIO;
 533                 }
 534
 535                 /* Send channel type */
 536                 len = ustcomm_send_unix_sock(sock, &type, sizeof(type));
 537                 if (len != sizeof(type)) {
 538                         if (len < 0)
 539                                 return len;
 540                         else
 541                                 return -EIO;
 542                 }
 543         }
 544
 545         /* Send channel data */
 546         len = ustcomm_send_unix_sock(sock, data, size);
 547         if (len != size) {
 548                 if (len < 0)
 549                         return len;
 550                 else
 551                         return -EIO;
 552         }
 553
 554         /* Send wakeup fd */
 555         len = ustcomm_send_fds_unix_sock(sock, &wakeup_fd, 1);
 556         if (len <= 0) {
 557                 if (len < 0)
 558                         return len;
 559                 else
 560                         return -EIO;
 561         }
 562         return 0;
 563 }
 564
 565 static
 566 int ustctl_send_stream(int sock,
 567                 uint32_t stream_nr,
 568                 uint64_t memory_map_size,
 569                 int shm_fd, int wakeup_fd,
 570                 int send_fd_only)
 571 {
 572         ssize_t len;
 573         int fds[2];
 574
 575         if (!send_fd_only) {
 576                 if (shm_fd < 0) {
 577                         /* finish iteration */
 578                         uint64_t v = -1;
 579
 580                         len = ustcomm_send_unix_sock(sock, &v, sizeof(v));
 581                         if (len != sizeof(v)) {
 582                                 if (len < 0)
 583                                         return len;
 584                                 else
 585                                         return -EIO;
 586                         }
 587                         return 0;
 588                 }
 589
 590                 /* Send mmap size */
 591                 len = ustcomm_send_unix_sock(sock, &memory_map_size,
 592                         sizeof(memory_map_size));
 593                 if (len != sizeof(memory_map_size)) {
 594                         if (len < 0)
 595                                 return len;
 596                         else
 597                                 return -EIO;
 598                 }
 599
 600                 /* Send stream nr */
 601                 len = ustcomm_send_unix_sock(sock, &stream_nr,
 602                         sizeof(stream_nr));
 603                 if (len != sizeof(stream_nr)) {
 604                         if (len < 0)
 605                                 return len;
 606                         else
 607                                 return -EIO;
 608                 }
 609         }
 610
 611         /* Send shm fd and wakeup fd */
 612         fds[0] = shm_fd;
 613         fds[1] = wakeup_fd;
 614         len = ustcomm_send_fds_unix_sock(sock, fds, 2);
 615         if (len <= 0) {
 616                 if (len < 0)
 617                         return len;
 618                 else
 619                         return -EIO;
 620         }
 621         return 0;
 622 }
 623
 624 int ustctl_recv_channel_from_consumer(int sock,
 625                 struct lttng_ust_object_data **_channel_data)
 626 {
 627         struct lttng_ust_object_data *channel_data;
 628         ssize_t len;
 629         int wakeup_fd;
 630         int ret;
 631
 632         channel_data = zmalloc(sizeof(*channel_data));
 633         if (!channel_data) {
 634                 ret = -ENOMEM;
 635                 goto error_alloc;
 636         }
 637         channel_data->type = LTTNG_UST_OBJECT_TYPE_CHANNEL;
 638         channel_data->handle = -1;
 639
 640         /* recv mmap size */
 641         len = ustcomm_recv_unix_sock(sock, &channel_data->size,
 642                         sizeof(channel_data->size));
 643         if (len != sizeof(channel_data->size)) {
 644                 if (len < 0)
 645                         ret = len;
 646                 else
 647                         ret = -EINVAL;
 648                 goto error;
 649         }
 650
 651         /* recv channel type */
 652         len = ustcomm_recv_unix_sock(sock, &channel_data->u.channel.type,
 653                         sizeof(channel_data->u.channel.type));
 654         if (len != sizeof(channel_data->u.channel.type)) {
 655                 if (len < 0)
 656                         ret = len;
 657                 else
 658                         ret = -EINVAL;
 659                 goto error;
 660         }
 661
 662         /* recv channel data */
 663         channel_data->u.channel.data = zmalloc(channel_data->size);
 664         if (!channel_data->u.channel.data) {
 665                 ret = -ENOMEM;
 666                 goto error;
 667         }
 668         len = ustcomm_recv_unix_sock(sock, channel_data->u.channel.data,
 669                         channel_data->size);
 670         if (len != channel_data->size) {
 671                 if (len < 0)
 672                         ret = len;
 673                 else
 674                         ret = -EINVAL;
 675                 goto error_recv_data;
 676         }
 677         /* recv wakeup fd */
 678         len = ustcomm_recv_fds_unix_sock(sock, &wakeup_fd, 1);
 679         if (len <= 0) {
 680                 if (len < 0) {
 681                         ret = len;
 682                         goto error_recv_data;
 683                 } else {
 684                         ret = -EIO;
 685                         goto error_recv_data;
 686                 }
 687         }
 688         channel_data->u.channel.wakeup_fd = wakeup_fd;
 689         *_channel_data = channel_data;
 690         return 0;
 691
 692 error_recv_data:
 693         free(channel_data->u.channel.data);
 694 error:
 695         free(channel_data);
 696 error_alloc:
 697         return ret;
 698 }
 699
 700 int ustctl_recv_stream_from_consumer(int sock,
 701                 struct lttng_ust_object_data **_stream_data)
 702 {
 703         struct lttng_ust_object_data *stream_data;
 704         ssize_t len;
 705         int ret;
 706         int fds[2];
 707
 708         stream_data = zmalloc(sizeof(*stream_data));
 709         if (!stream_data) {
 710                 ret = -ENOMEM;
 711                 goto error_alloc;
 712         }
 713
 714         stream_data->type = LTTNG_UST_OBJECT_TYPE_STREAM;
 715         stream_data->handle = -1;
 716
 717         /* recv mmap size */
 718         len = ustcomm_recv_unix_sock(sock, &stream_data->size,
 719                         sizeof(stream_data->size));
 720         if (len != sizeof(stream_data->size)) {
 721                 if (len < 0)
 722                         ret = len;
 723                 else
 724                         ret = -EINVAL;
 725                 goto error;
 726         }
 727         if (stream_data->size == -1) {
 728                 ret = -LTTNG_UST_ERR_NOENT;
 729                 goto error;
 730         }
 731
 732         /* recv stream nr */
 733         len = ustcomm_recv_unix_sock(sock, &stream_data->u.stream.stream_nr,
 734                         sizeof(stream_data->u.stream.stream_nr));
 735         if (len != sizeof(stream_data->u.stream.stream_nr)) {
 736                 if (len < 0)
 737                         ret = len;
 738                 else
 739                         ret = -EINVAL;
 740                 goto error;
 741         }
 742
 743         /* recv shm fd and wakeup fd */
 744         len = ustcomm_recv_fds_unix_sock(sock, fds, 2);
 745         if (len <= 0) {
 746                 if (len < 0) {
 747                         ret = len;
 748                         goto error;
 749                 } else {
 750                         ret = -EIO;
 751                         goto error;
 752                 }
 753         }
 754         stream_data->u.stream.shm_fd = fds[0];
 755         stream_data->u.stream.wakeup_fd = fds[1];
 756         *_stream_data = stream_data;
 757         return 0;
 758
 759 error:
 760         free(stream_data);
 761 error_alloc:
 762         return ret;
 763 }
 764
 765 int ustctl_send_channel_to_ust(int sock, int session_handle,
 766                 struct lttng_ust_object_data *channel_data)
 767 {
 768         struct ustcomm_ust_msg lum;
 769         struct ustcomm_ust_reply lur;
 770         int ret;
 771
 772         if (!channel_data)
 773                 return -EINVAL;
 774
 775         memset(&lum, 0, sizeof(lum));
 776         lum.handle = session_handle;
 777         lum.cmd = LTTNG_UST_CHANNEL;
 778         lum.u.channel.len = channel_data->size;
 779         lum.u.channel.type = channel_data->u.channel.type;
 780         ret = ustcomm_send_app_msg(sock, &lum);
 781         if (ret)
 782                 return ret;
 783
 784         ret = ustctl_send_channel(sock,
 785                         channel_data->u.channel.type,
 786                         channel_data->u.channel.data,
 787                         channel_data->size,
 788                         channel_data->u.channel.wakeup_fd,
 789                         1);
 790         if (ret)
 791                 return ret;
 792         ret = ustcomm_recv_app_reply(sock, &lur, lum.handle, lum.cmd);
 793         if (!ret) {
 794                 channel_data->handle = lur.ret_val;
 795         }
 796         return ret;
 797 }
 798
 799 int ustctl_send_stream_to_ust(int sock,
 800                 struct lttng_ust_object_data *channel_data,
 801                 struct lttng_ust_object_data *stream_data)
 802 {
 803         struct ustcomm_ust_msg lum;
 804         struct ustcomm_ust_reply lur;
 805         int ret;
 806
 807         memset(&lum, 0, sizeof(lum));
 808         lum.handle = channel_data->handle;
 809         lum.cmd = LTTNG_UST_STREAM;
 810         lum.u.stream.len = stream_data->size;
 811         lum.u.stream.stream_nr = stream_data->u.stream.stream_nr;
 812         ret = ustcomm_send_app_msg(sock, &lum);
 813         if (ret)
 814                 return ret;
 815
 816         assert(stream_data);
 817         assert(stream_data->type == LTTNG_UST_OBJECT_TYPE_STREAM);
 818
 819         ret = ustctl_send_stream(sock,
 820                         stream_data->u.stream.stream_nr,
 821                         stream_data->size,
 822                         stream_data->u.stream.shm_fd,
 823                         stream_data->u.stream.wakeup_fd, 1);
 824         if (ret)
 825                 return ret;
 826         return ustcomm_recv_app_reply(sock, &lur, lum.handle, lum.cmd);
 827 }
 828
 829 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
 830                 struct lttng_ust_object_data *src)
 831 {
 832         struct lttng_ust_object_data *obj;
 833         int ret;
 834
 835         if (src->handle != -1) {
 836                 ret = -EINVAL;
 837                 goto error;
 838         }
 839
 840         obj = zmalloc(sizeof(*obj));
 841         if (!obj) {
 842                 ret = -ENOMEM;
 843                 goto error;
 844         }
 845
 846         obj->type = src->type;
 847         obj->handle = src->handle;
 848         obj->size = src->size;
 849
 850         switch (obj->type) {
 851         case LTTNG_UST_OBJECT_TYPE_CHANNEL:
 852         {
 853                 obj->u.channel.type = src->u.channel.type;
 854                 if (src->u.channel.wakeup_fd >= 0) {
 855                         obj->u.channel.wakeup_fd =
 856                                 dup(src->u.channel.wakeup_fd);
 857                         if (obj->u.channel.wakeup_fd < 0) {
 858                                 ret = errno;
 859                                 goto chan_error_wakeup_fd;
 860                         }
 861                 } else {
 862                         obj->u.channel.wakeup_fd =
 863                                 src->u.channel.wakeup_fd;
 864                 }
 865                 obj->u.channel.data = zmalloc(obj->size);
 866                 if (!obj->u.channel.data) {
 867                         ret = -ENOMEM;
 868                         goto chan_error_alloc;
 869                 }
 870                 memcpy(obj->u.channel.data, src->u.channel.data, obj->size);
 871                 break;
 872
 873         chan_error_alloc:
 874                 if (src->u.channel.wakeup_fd >= 0) {
 875                         int closeret;
 876
 877                         closeret = close(obj->u.channel.wakeup_fd);
 878                         if (closeret) {
 879                                 PERROR("close");
 880                         }
 881                 }
 882         chan_error_wakeup_fd:
 883                 goto error_type;
 884
 885         }
 886
 887         case LTTNG_UST_OBJECT_TYPE_STREAM:
 888         {
 889                 obj->u.stream.stream_nr = src->u.stream.stream_nr;
 890                 if (src->u.stream.wakeup_fd >= 0) {
 891                         obj->u.stream.wakeup_fd =
 892                                 dup(src->u.stream.wakeup_fd);
 893                         if (obj->u.stream.wakeup_fd < 0) {
 894                                 ret = errno;
 895                                 goto stream_error_wakeup_fd;
 896                         }
 897                 } else {
 898                         obj->u.stream.wakeup_fd =
 899                                 src->u.stream.wakeup_fd;
 900                 }
 901
 902                 if (src->u.stream.shm_fd >= 0) {
 903                         obj->u.stream.shm_fd =
 904                                 dup(src->u.stream.shm_fd);
 905                         if (obj->u.stream.shm_fd < 0) {
 906                                 ret = errno;
 907                                 goto stream_error_shm_fd;
 908                         }
 909                 } else {
 910                         obj->u.stream.shm_fd =
 911                                 src->u.stream.shm_fd;
 912                 }
 913                 break;
 914
 915         stream_error_shm_fd:
 916                 if (src->u.stream.wakeup_fd >= 0) {
 917                         int closeret;
 918
 919                         closeret = close(obj->u.stream.wakeup_fd);
 920                         if (closeret) {
 921                                 PERROR("close");
 922                         }
 923                 }
 924         stream_error_wakeup_fd:
 925                 goto error_type;
 926         }
 927
 928         default:
 929                 ret = -EINVAL;
 930                 goto error_type;
 931         }
 932
 933         *dest = obj;
 934         return 0;
 935
 936 error_type:
 937         free(obj);
 938 error:
 939         return ret;
 940 }
 941
 942
 943 /* Buffer operations */
 944
 945 struct ustctl_consumer_channel *
 946         ustctl_create_channel(struct ustctl_consumer_channel_attr *attr)
 947 {
 948         struct ustctl_consumer_channel *chan;
 949         const char *transport_name;
 950         struct lttng_transport *transport;
 951
 952         switch (attr->type) {
 953         case LTTNG_UST_CHAN_PER_CPU:
 954                 if (attr->output == LTTNG_UST_MMAP) {
 955                         if (attr->overwrite) {
 956                                 if (attr->read_timer_interval == 0) {
 957                                         transport_name = "relay-overwrite-mmap";
 958                                 } else {
 959                                         transport_name = "relay-overwrite-rt-mmap";
 960                                 }
 961                         } else {
 962                                 if (attr->read_timer_interval == 0) {
 963                                         transport_name = "relay-discard-mmap";
 964                                 } else {
 965                                         transport_name = "relay-discard-rt-mmap";
 966                                 }
 967                         }
 968                 } else {
 969                         return NULL;
 970                 }
 971                 break;
 972         case LTTNG_UST_CHAN_METADATA:
 973                 if (attr->output == LTTNG_UST_MMAP)
 974                         transport_name = "relay-metadata-mmap";
 975                 else
 976                         return NULL;
 977                 break;
 978         default:
 979                 transport_name = "<unknown>";
 980                 return NULL;
 981         }
 982
 983         transport = lttng_transport_find(transport_name);
 984         if (!transport) {
 985                 DBG("LTTng transport %s not found\n",
 986                         transport_name);
 987                 return NULL;
 988         }
 989
 990         chan = zmalloc(sizeof(*chan));
 991         if (!chan)
 992                 return NULL;
 993
 994         chan->chan = transport->ops.channel_create(transport_name, NULL,
 995                         attr->subbuf_size, attr->num_subbuf,
 996                         attr->switch_timer_interval,
 997                         attr->read_timer_interval,
 998                         attr->uuid, attr->chan_id);
 999         if (!chan->chan) {
1000                 goto chan_error;
1001         }
1002         chan->chan->ops = &transport->ops;
1003         memcpy(&chan->attr, attr, sizeof(chan->attr));
1004         chan->wait_fd = ustctl_channel_get_wait_fd(chan);
1005         chan->wakeup_fd = ustctl_channel_get_wakeup_fd(chan);
1006         return chan;
1007
1008 chan_error:
1009         free(chan);
1010         return NULL;
1011 }
1012
1013 void ustctl_destroy_channel(struct ustctl_consumer_channel *chan)
1014 {
1015         chan->chan->ops->channel_destroy(chan->chan);
1016         free(chan);
1017 }
1018
1019 int ustctl_send_channel_to_sessiond(int sock,
1020                 struct ustctl_consumer_channel *channel)
1021 {
1022         struct shm_object_table *table;
1023
1024         table = channel->chan->handle->table;
1025         if (table->size <= 0)
1026                 return -EINVAL;
1027         return ustctl_send_channel(sock,
1028                         channel->attr.type,
1029                         table->objects[0].memory_map,
1030                         table->objects[0].memory_map_size,
1031                         channel->wakeup_fd,
1032                         0);
1033 }
1034
1035 int ustctl_send_stream_to_sessiond(int sock,
1036                 struct ustctl_consumer_stream *stream)
1037 {
1038         if (!stream)
1039                 return ustctl_send_stream(sock, -1U, -1U, -1, -1, 0);
1040
1041         return ustctl_send_stream(sock,
1042                         stream->cpu,
1043                         stream->memory_map_size,
1044                         stream->shm_fd, stream->wakeup_fd,
1045                         0);
1046 }
1047
1048 int ustctl_write_metadata_to_channel(
1049                 struct ustctl_consumer_channel *channel,
1050                 const char *metadata_str,       /* NOT null-terminated */
1051                 size_t len)                     /* metadata length */
1052 {
1053         struct lttng_ust_lib_ring_buffer_ctx ctx;
1054         struct lttng_channel *chan = channel->chan;
1055         const char *str = metadata_str;
1056         int ret = 0, waitret;
1057         size_t reserve_len, pos;
1058
1059         for (pos = 0; pos < len; pos += reserve_len) {
1060                 reserve_len = min_t(size_t,
1061                                 chan->ops->packet_avail_size(chan->chan, chan->handle),
1062                                 len - pos);
1063                 lib_ring_buffer_ctx_init(&ctx, chan->chan, NULL, reserve_len,
1064                                          sizeof(char), -1, chan->handle);
1065                 /*
1066                  * We don't care about metadata buffer's records lost
1067                  * count, because we always retry here. Report error if
1068                  * we need to bail out after timeout or being
1069                  * interrupted.
1070                  */
1071                 waitret = wait_cond_interruptible_timeout(
1072                         ({
1073                                 ret = chan->ops->event_reserve(&ctx, 0);
1074                                 ret != -ENOBUFS || !ret;
1075                         }),
1076                         LTTNG_METADATA_TIMEOUT_MSEC);
1077                 if (waitret == -ETIMEDOUT || waitret == -EINTR || ret) {
1078                         DBG("LTTng: Failure to write metadata to buffers (%s)\n",
1079                                 waitret == -EINTR ? "interrupted" :
1080                                         (ret == -ENOBUFS ? "timeout" : "I/O error"));
1081                         if (waitret == -EINTR)
1082                                 ret = waitret;
1083                         goto end;
1084                 }
1085                 chan->ops->event_write(&ctx, &str[pos], reserve_len);
1086                 chan->ops->event_commit(&ctx);
1087         }
1088 end:
1089         return ret;
1090 }
1091
1092 /*
1093  * Write at most one packet in the channel.
1094  * Returns the number of bytes written on success, < 0 on error.
1095  */
1096 ssize_t ustctl_write_one_packet_to_channel(
1097                 struct ustctl_consumer_channel *channel,
1098                 const char *metadata_str,       /* NOT null-terminated */
1099                 size_t len)                     /* metadata length */
1100 {
1101         struct lttng_ust_lib_ring_buffer_ctx ctx;
1102         struct lttng_channel *chan = channel->chan;
1103         const char *str = metadata_str;
1104         ssize_t reserve_len;
1105         int ret;
1106
1107         reserve_len = min_t(ssize_t,
1108                         chan->ops->packet_avail_size(chan->chan, chan->handle),
1109                         len);
1110         lib_ring_buffer_ctx_init(&ctx, chan->chan, NULL, reserve_len,
1111                         sizeof(char), -1, chan->handle);
1112         ret = chan->ops->event_reserve(&ctx, 0);
1113         if (ret != 0) {
1114                 DBG("LTTng: event reservation failed");
1115                 assert(ret < 0);
1116                 reserve_len = ret;
1117                 goto end;
1118         }
1119         chan->ops->event_write(&ctx, str, reserve_len);
1120         chan->ops->event_commit(&ctx);
1121
1122 end:
1123         return reserve_len;
1124 }
1125
1126 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan)
1127 {
1128         struct channel *chan;
1129         int ret;
1130
1131         chan = consumer_chan->chan->chan;
1132         ret = ring_buffer_channel_close_wait_fd(&chan->backend.config,
1133                         chan, chan->handle);
1134         if (!ret)
1135                 consumer_chan->wait_fd = -1;
1136         return ret;
1137 }
1138
1139 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan)
1140 {
1141         struct channel *chan;
1142         int ret;
1143
1144         chan = consumer_chan->chan->chan;
1145         ret = ring_buffer_channel_close_wakeup_fd(&chan->backend.config,
1146                         chan, chan->handle);
1147         if (!ret)
1148                 consumer_chan->wakeup_fd = -1;
1149         return ret;
1150 }
1151
1152 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream)
1153 {
1154         struct channel *chan;
1155
1156         chan = stream->chan->chan->chan;
1157         return ring_buffer_stream_close_wait_fd(&chan->backend.config,
1158                         chan, stream->handle, stream->cpu);
1159 }
1160
1161 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream)
1162 {
1163         struct channel *chan;
1164
1165         chan = stream->chan->chan->chan;
1166         return ring_buffer_stream_close_wakeup_fd(&chan->backend.config,
1167                         chan, stream->handle, stream->cpu);
1168 }
1169
1170 struct ustctl_consumer_stream *
1171         ustctl_create_stream(struct ustctl_consumer_channel *channel,
1172                         int cpu)
1173 {
1174         struct ustctl_consumer_stream *stream;
1175         struct lttng_ust_shm_handle *handle;
1176         struct channel *chan;
1177         int shm_fd, wait_fd, wakeup_fd;
1178         uint64_t memory_map_size;
1179         struct lttng_ust_lib_ring_buffer *buf;
1180         int ret;
1181
1182         if (!channel)
1183                 return NULL;
1184         handle = channel->chan->handle;
1185         if (!handle)
1186                 return NULL;
1187
1188         chan = channel->chan->chan;
1189         buf = channel_get_ring_buffer(&chan->backend.config,
1190                 chan, cpu, handle, &shm_fd, &wait_fd,
1191                 &wakeup_fd, &memory_map_size);
1192         if (!buf)
1193                 return NULL;
1194         ret = lib_ring_buffer_open_read(buf, handle);
1195         if (ret)
1196                 return NULL;
1197
1198         stream = zmalloc(sizeof(*stream));
1199         if (!stream)
1200                 goto alloc_error;
1201         stream->handle = handle;
1202         stream->buf = buf;
1203         stream->chan = channel;
1204         stream->shm_fd = shm_fd;
1205         stream->wait_fd = wait_fd;
1206         stream->wakeup_fd = wakeup_fd;
1207         stream->memory_map_size = memory_map_size;
1208         stream->cpu = cpu;
1209         return stream;
1210
1211 alloc_error:
1212         return NULL;
1213 }
1214
1215 void ustctl_destroy_stream(struct ustctl_consumer_stream *stream)
1216 {
1217         struct lttng_ust_lib_ring_buffer *buf;
1218         struct ustctl_consumer_channel *consumer_chan;
1219
1220         assert(stream);
1221         buf = stream->buf;
1222         consumer_chan = stream->chan;
1223         lib_ring_buffer_release_read(buf, consumer_chan->chan->handle);
1224         free(stream);
1225 }
1226
1227 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *chan)
1228 {
1229         if (!chan)
1230                 return -EINVAL;
1231         return shm_get_wait_fd(chan->chan->handle,
1232                 &chan->chan->handle->chan._ref);
1233 }
1234
1235 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *chan)
1236 {
1237         if (!chan)
1238                 return -EINVAL;
1239         return shm_get_wakeup_fd(chan->chan->handle,
1240                 &chan->chan->handle->chan._ref);
1241 }
1242
1243 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream)
1244 {
1245         struct lttng_ust_lib_ring_buffer *buf;
1246         struct ustctl_consumer_channel *consumer_chan;
1247
1248         if (!stream)
1249                 return -EINVAL;
1250         buf = stream->buf;
1251         consumer_chan = stream->chan;
1252         return shm_get_wait_fd(consumer_chan->chan->handle, &buf->self._ref);
1253 }
1254
1255 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream)
1256 {
1257         struct lttng_ust_lib_ring_buffer *buf;
1258         struct ustctl_consumer_channel *consumer_chan;
1259
1260         if (!stream)
1261                 return -EINVAL;
1262         buf = stream->buf;
1263         consumer_chan = stream->chan;
1264         return shm_get_wakeup_fd(consumer_chan->chan->handle, &buf->self._ref);
1265 }
1266
1267 /* For mmap mode, readable without "get" operation */
1268
1269 void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream)
1270 {
1271         struct lttng_ust_lib_ring_buffer *buf;
1272         struct ustctl_consumer_channel *consumer_chan;
1273
1274         if (!stream)
1275                 return NULL;
1276         buf = stream->buf;
1277         consumer_chan = stream->chan;
1278         return shmp(consumer_chan->chan->handle, buf->backend.memory_map);
1279 }
1280
1281 /* returns the length to mmap. */
1282 int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
1283                 unsigned long *len)
1284 {
1285         struct ustctl_consumer_channel *consumer_chan;
1286         unsigned long mmap_buf_len;
1287         struct channel *chan;
1288
1289         if (!stream)
1290                 return -EINVAL;
1291         consumer_chan = stream->chan;
1292         chan = consumer_chan->chan->chan;
1293         if (chan->backend.config.output != RING_BUFFER_MMAP)
1294                 return -EINVAL;
1295         mmap_buf_len = chan->backend.buf_size;
1296         if (chan->backend.extra_reader_sb)
1297                 mmap_buf_len += chan->backend.subbuf_size;
1298         if (mmap_buf_len > INT_MAX)
1299                 return -EFBIG;
1300         *len = mmap_buf_len;
1301         return 0;
1302 }
1303
1304 /* returns the maximum size for sub-buffers. */
1305 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
1306                 unsigned long *len)
1307 {
1308         struct ustctl_consumer_channel *consumer_chan;
1309         struct channel *chan;
1310
1311         if (!stream)
1312                 return -EINVAL;
1313         consumer_chan = stream->chan;
1314         chan = consumer_chan->chan->chan;
1315         *len = chan->backend.subbuf_size;
1316         return 0;
1317 }
1318
1319 /*
1320  * For mmap mode, operate on the current packet (between get/put or
1321  * get_next/put_next).
1322  */
1323
1324 /* returns the offset of the subbuffer belonging to the mmap reader. */
1325 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
1326                 unsigned long *off)
1327 {
1328         struct channel *chan;
1329         unsigned long sb_bindex;
1330         struct lttng_ust_lib_ring_buffer *buf;
1331         struct ustctl_consumer_channel *consumer_chan;
1332
1333         if (!stream)
1334                 return -EINVAL;
1335         buf = stream->buf;
1336         consumer_chan = stream->chan;
1337         chan = consumer_chan->chan->chan;
1338         if (chan->backend.config.output != RING_BUFFER_MMAP)
1339                 return -EINVAL;
1340         sb_bindex = subbuffer_id_get_index(&chan->backend.config,
1341                                         buf->backend.buf_rsb.id);
1342         *off = shmp(consumer_chan->chan->handle,
1343                 shmp_index(consumer_chan->chan->handle, buf->backend.array, sb_bindex)->shmp)->mmap_offset;
1344         return 0;
1345 }
1346
1347 /* returns the size of the current sub-buffer, without padding (for mmap). */
1348 int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
1349                 unsigned long *len)
1350 {
1351         struct ustctl_consumer_channel *consumer_chan;
1352         struct channel *chan;
1353         struct lttng_ust_lib_ring_buffer *buf;
1354
1355         if (!stream)
1356                 return -EINVAL;
1357
1358         buf = stream->buf;
1359         consumer_chan = stream->chan;
1360         chan = consumer_chan->chan->chan;
1361         *len = lib_ring_buffer_get_read_data_size(&chan->backend.config, buf,
1362                 consumer_chan->chan->handle);
1363         return 0;
1364 }
1365
1366 /* returns the size of the current sub-buffer, without padding (for mmap). */
1367 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
1368                 unsigned long *len)
1369 {
1370         struct ustctl_consumer_channel *consumer_chan;
1371         struct channel *chan;
1372         struct lttng_ust_lib_ring_buffer *buf;
1373
1374         if (!stream)
1375                 return -EINVAL;
1376         buf = stream->buf;
1377         consumer_chan = stream->chan;
1378         chan = consumer_chan->chan->chan;
1379         *len = lib_ring_buffer_get_read_data_size(&chan->backend.config, buf,
1380                 consumer_chan->chan->handle);
1381         *len = PAGE_ALIGN(*len);
1382         return 0;
1383 }
1384
1385 /* Get exclusive read access to the next sub-buffer that can be read. */
1386 int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream)
1387 {
1388         struct lttng_ust_lib_ring_buffer *buf;
1389         struct ustctl_consumer_channel *consumer_chan;
1390
1391         if (!stream)
1392                 return -EINVAL;
1393         buf = stream->buf;
1394         consumer_chan = stream->chan;
1395         return lib_ring_buffer_get_next_subbuf(buf,
1396                         consumer_chan->chan->handle);
1397 }
1398
1399
1400 /* Release exclusive sub-buffer access, move consumer forward. */
1401 int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream)
1402 {
1403         struct lttng_ust_lib_ring_buffer *buf;
1404         struct ustctl_consumer_channel *consumer_chan;
1405
1406         if (!stream)
1407                 return -EINVAL;
1408         buf = stream->buf;
1409         consumer_chan = stream->chan;
1410         lib_ring_buffer_put_next_subbuf(buf, consumer_chan->chan->handle);
1411         return 0;
1412 }
1413
1414 /* snapshot */
1415
1416 /* Get a snapshot of the current ring buffer producer and consumer positions */
1417 int ustctl_snapshot(struct ustctl_consumer_stream *stream)
1418 {
1419         struct lttng_ust_lib_ring_buffer *buf;
1420         struct ustctl_consumer_channel *consumer_chan;
1421
1422         if (!stream)
1423                 return -EINVAL;
1424         buf = stream->buf;
1425         consumer_chan = stream->chan;
1426         return lib_ring_buffer_snapshot(buf, &buf->cons_snapshot,
1427                         &buf->prod_snapshot, consumer_chan->chan->handle);
1428 }
1429
1430 /* Get the consumer position (iteration start) */
1431 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
1432                 unsigned long *pos)
1433 {
1434         struct lttng_ust_lib_ring_buffer *buf;
1435
1436         if (!stream)
1437                 return -EINVAL;
1438         buf = stream->buf;
1439         *pos = buf->cons_snapshot;
1440         return 0;
1441 }
1442
1443 /* Get the producer position (iteration end) */
1444 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
1445                 unsigned long *pos)
1446 {
1447         struct lttng_ust_lib_ring_buffer *buf;
1448
1449         if (!stream)
1450                 return -EINVAL;
1451         buf = stream->buf;
1452         *pos = buf->prod_snapshot;
1453         return 0;
1454 }
1455
1456 /* Get exclusive read access to the specified sub-buffer position */
1457 int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
1458                 unsigned long *pos)
1459 {
1460         struct lttng_ust_lib_ring_buffer *buf;
1461         struct ustctl_consumer_channel *consumer_chan;
1462
1463         if (!stream)
1464                 return -EINVAL;
1465         buf = stream->buf;
1466         consumer_chan = stream->chan;
1467         return lib_ring_buffer_get_subbuf(buf, *pos,
1468                         consumer_chan->chan->handle);
1469 }
1470
1471 /* Release exclusive sub-buffer access */
1472 int ustctl_put_subbuf(struct ustctl_consumer_stream *stream)
1473 {
1474         struct lttng_ust_lib_ring_buffer *buf;
1475         struct ustctl_consumer_channel *consumer_chan;
1476
1477         if (!stream)
1478                 return -EINVAL;
1479         buf = stream->buf;
1480         consumer_chan = stream->chan;
1481         lib_ring_buffer_put_subbuf(buf, consumer_chan->chan->handle);
1482         return 0;
1483 }
1484
1485 void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
1486                 int producer_active)
1487 {
1488         struct lttng_ust_lib_ring_buffer *buf;
1489         struct ustctl_consumer_channel *consumer_chan;
1490
1491         assert(stream);
1492         buf = stream->buf;
1493         consumer_chan = stream->chan;
1494         lib_ring_buffer_switch_slow(buf,
1495                 producer_active ? SWITCH_ACTIVE : SWITCH_FLUSH,
1496                 consumer_chan->chan->handle);
1497 }
1498
1499 static
1500 struct lttng_ust_client_lib_ring_buffer_client_cb *get_client_cb(
1501                 struct lttng_ust_lib_ring_buffer *buf,
1502                 struct lttng_ust_shm_handle *handle)
1503 {
1504         struct channel *chan;
1505         const struct lttng_ust_lib_ring_buffer_config *config;
1506         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1507
1508         chan = shmp(handle, buf->backend.chan);
1509         config = &chan->backend.config;
1510         if (!config->cb_ptr)
1511                 return NULL;
1512         client_cb = caa_container_of(config->cb_ptr,
1513                         struct lttng_ust_client_lib_ring_buffer_client_cb,
1514                         parent);
1515         return client_cb;
1516 }
1517
1518 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
1519                 uint64_t *timestamp_begin)
1520 {
1521         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1522         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1523         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1524
1525         if (!stream || !timestamp_begin)
1526                 return -EINVAL;
1527         client_cb = get_client_cb(buf, handle);
1528         if (!client_cb)
1529                 return -ENOSYS;
1530         return client_cb->timestamp_begin(buf, handle, timestamp_begin);
1531 }
1532
1533 int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
1534         uint64_t *timestamp_end)
1535 {
1536         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1537         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1538         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1539
1540         if (!stream || !timestamp_end)
1541                 return -EINVAL;
1542         client_cb = get_client_cb(buf, handle);
1543         if (!client_cb)
1544                 return -ENOSYS;
1545         return client_cb->timestamp_end(buf, handle, timestamp_end);
1546 }
1547
1548 int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
1549         uint64_t *events_discarded)
1550 {
1551         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1552         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1553         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1554
1555         if (!stream || !events_discarded)
1556                 return -EINVAL;
1557         client_cb = get_client_cb(buf, handle);
1558         if (!client_cb)
1559                 return -ENOSYS;
1560         return client_cb->events_discarded(buf, handle, events_discarded);
1561 }
1562
1563 int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
1564         uint64_t *content_size)
1565 {
1566         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1567         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1568         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1569
1570         if (!stream || !content_size)
1571                 return -EINVAL;
1572         client_cb = get_client_cb(buf, handle);
1573         if (!client_cb)
1574                 return -ENOSYS;
1575         return client_cb->content_size(buf, handle, content_size);
1576 }
1577
1578 int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
1579         uint64_t *packet_size)
1580 {
1581         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1582         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1583         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1584
1585         if (!stream || !packet_size)
1586                 return -EINVAL;
1587         client_cb = get_client_cb(buf, handle);
1588         if (!client_cb)
1589                 return -ENOSYS;
1590         return client_cb->packet_size(buf, handle, packet_size);
1591 }
1592
1593 int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
1594                 uint64_t *stream_id)
1595 {
1596         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1597         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1598         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1599
1600         if (!stream || !stream_id)
1601                 return -EINVAL;
1602         client_cb = get_client_cb(buf, handle);
1603         if (!client_cb)
1604                 return -ENOSYS;
1605         return client_cb->stream_id(buf, handle, stream_id);
1606 }
1607
1608 int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
1609                 uint64_t *ts)
1610 {
1611         struct lttng_ust_client_lib_ring_buffer_client_cb *client_cb;
1612         struct lttng_ust_lib_ring_buffer *buf = stream->buf;
1613         struct lttng_ust_shm_handle *handle = stream->chan->chan->handle;
1614
1615         if (!stream || !ts)
1616                 return -EINVAL;
1617         client_cb = get_client_cb(buf, handle);
1618         if (!client_cb || !client_cb->current_timestamp)
1619                 return -ENOSYS;
1620         return client_cb->current_timestamp(buf, handle, ts);
1621 }
1622
1623 /*
1624  * Returns 0 on success, negative error value on error.
1625  */
1626 int ustctl_recv_reg_msg(int sock,
1627         enum ustctl_socket_type *type,
1628         uint32_t *major,
1629         uint32_t *minor,
1630         uint32_t *pid,
1631         uint32_t *ppid,
1632         uint32_t *uid,
1633         uint32_t *gid,
1634         uint32_t *bits_per_long,
1635         uint32_t *uint8_t_alignment,
1636         uint32_t *uint16_t_alignment,
1637         uint32_t *uint32_t_alignment,
1638         uint32_t *uint64_t_alignment,
1639         uint32_t *long_alignment,
1640         int *byte_order,
1641         char *name)
1642 {
1643         ssize_t len;
1644         struct ustctl_reg_msg reg_msg;
1645
1646         len = ustcomm_recv_unix_sock(sock, &reg_msg, sizeof(reg_msg));
1647         if (len > 0 && len != sizeof(reg_msg))
1648                 return -EIO;
1649         if (len == 0)
1650                 return -EPIPE;
1651         if (len < 0)
1652                 return len;
1653
1654         if (reg_msg.magic == LTTNG_UST_COMM_MAGIC) {
1655                 *byte_order = BYTE_ORDER == BIG_ENDIAN ?
1656                                 BIG_ENDIAN : LITTLE_ENDIAN;
1657         } else if (reg_msg.magic == bswap_32(LTTNG_UST_COMM_MAGIC)) {
1658                 *byte_order = BYTE_ORDER == BIG_ENDIAN ?
1659                                 LITTLE_ENDIAN : BIG_ENDIAN;
1660         } else {
1661                 return -LTTNG_UST_ERR_INVAL_MAGIC;
1662         }
1663         switch (reg_msg.socket_type) {
1664         case 0: *type = USTCTL_SOCKET_CMD;
1665                 break;
1666         case 1: *type = USTCTL_SOCKET_NOTIFY;
1667                 break;
1668         default:
1669                 return -LTTNG_UST_ERR_INVAL_SOCKET_TYPE;
1670         }
1671         *major = reg_msg.major;
1672         *minor = reg_msg.minor;
1673         *pid = reg_msg.pid;
1674         *ppid = reg_msg.ppid;
1675         *uid = reg_msg.uid;
1676         *gid = reg_msg.gid;
1677         *bits_per_long = reg_msg.bits_per_long;
1678         *uint8_t_alignment = reg_msg.uint8_t_alignment;
1679         *uint16_t_alignment = reg_msg.uint16_t_alignment;
1680         *uint32_t_alignment = reg_msg.uint32_t_alignment;
1681         *uint64_t_alignment = reg_msg.uint64_t_alignment;
1682         *long_alignment = reg_msg.long_alignment;
1683         memcpy(name, reg_msg.name, LTTNG_UST_ABI_PROCNAME_LEN);
1684         if (reg_msg.major != LTTNG_UST_ABI_MAJOR_VERSION) {
1685                 return -LTTNG_UST_ERR_UNSUP_MAJOR;
1686         }
1687
1688         return 0;
1689 }
1690
1691 int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd)
1692 {
1693         struct ustcomm_notify_hdr header;
1694         ssize_t len;
1695
1696         len = ustcomm_recv_unix_sock(sock, &header, sizeof(header));
1697         if (len > 0 && len != sizeof(header))
1698                 return -EIO;
1699         if (len == 0)
1700                 return -EPIPE;
1701         if (len < 0)
1702                 return len;
1703         switch (header.notify_cmd) {
1704         case 0:
1705                 *notify_cmd = USTCTL_NOTIFY_CMD_EVENT;
1706                 break;
1707         case 1:
1708                 *notify_cmd = USTCTL_NOTIFY_CMD_CHANNEL;
1709                 break;
1710         default:
1711                 return -EINVAL;
1712         }
1713         return 0;
1714 }
1715
1716 /*
1717  * Returns 0 on success, negative error value on error.
1718  */
1719 int ustctl_recv_register_event(int sock,
1720         int *session_objd,
1721         int *channel_objd,
1722         char *event_name,
1723         int *loglevel,
1724         char **signature,
1725         size_t *nr_fields,
1726         struct ustctl_field **fields,
1727         char **model_emf_uri)
1728 {
1729         ssize_t len;
1730         struct ustcomm_notify_event_msg msg;
1731         size_t signature_len, fields_len, model_emf_uri_len;
1732         char *a_sign = NULL, *a_model_emf_uri = NULL;
1733         struct ustctl_field *a_fields = NULL;
1734
1735         len = ustcomm_recv_unix_sock(sock, &msg, sizeof(msg));
1736         if (len > 0 && len != sizeof(msg))
1737                 return -EIO;
1738         if (len == 0)
1739                 return -EPIPE;
1740         if (len < 0)
1741                 return len;
1742
1743         *session_objd = msg.session_objd;
1744         *channel_objd = msg.channel_objd;
1745         strncpy(event_name, msg.event_name, LTTNG_UST_SYM_NAME_LEN);
1746         event_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1747         *loglevel = msg.loglevel;
1748         signature_len = msg.signature_len;
1749         fields_len = msg.fields_len;
1750
1751         if (fields_len % sizeof(*a_fields) != 0) {
1752                 return -EINVAL;
1753         }
1754
1755         model_emf_uri_len = msg.model_emf_uri_len;
1756
1757         /* recv signature. contains at least \0. */
1758         a_sign = zmalloc(signature_len);
1759         if (!a_sign)
1760                 return -ENOMEM;
1761         len = ustcomm_recv_unix_sock(sock, a_sign, signature_len);
1762         if (len > 0 && len != signature_len) {
1763                 len = -EIO;
1764                 goto signature_error;
1765         }
1766         if (len == 0) {
1767                 len = -EPIPE;
1768                 goto signature_error;
1769         }
1770         if (len < 0) {
1771                 goto signature_error;
1772         }
1773         /* Enforce end of string */
1774         a_sign[signature_len - 1] = '\0';
1775
1776         /* recv fields */
1777         if (fields_len) {
1778                 a_fields = zmalloc(fields_len);
1779                 if (!a_fields) {
1780                         len = -ENOMEM;
1781                         goto signature_error;
1782                 }
1783                 len = ustcomm_recv_unix_sock(sock, a_fields, fields_len);
1784                 if (len > 0 && len != fields_len) {
1785                         len = -EIO;
1786                         goto fields_error;
1787                 }
1788                 if (len == 0) {
1789                         len = -EPIPE;
1790                         goto fields_error;
1791                 }
1792                 if (len < 0) {
1793                         goto fields_error;
1794                 }
1795         }
1796
1797         if (model_emf_uri_len) {
1798                 /* recv model_emf_uri_len */
1799                 a_model_emf_uri = zmalloc(model_emf_uri_len);
1800                 if (!a_model_emf_uri) {
1801                         len = -ENOMEM;
1802                         goto fields_error;
1803                 }
1804                 len = ustcomm_recv_unix_sock(sock, a_model_emf_uri,
1805                                 model_emf_uri_len);
1806                 if (len > 0 && len != model_emf_uri_len) {
1807                         len = -EIO;
1808                         goto model_error;
1809                 }
1810                 if (len == 0) {
1811                         len = -EPIPE;
1812                         goto model_error;
1813                 }
1814                 if (len < 0) {
1815                         goto model_error;
1816                 }
1817                 /* Enforce end of string */
1818                 a_model_emf_uri[model_emf_uri_len - 1] = '\0';
1819         }
1820
1821         *signature = a_sign;
1822         *nr_fields = fields_len / sizeof(*a_fields);
1823         *fields = a_fields;
1824         *model_emf_uri = a_model_emf_uri;
1825
1826         return 0;
1827
1828 model_error:
1829         free(a_model_emf_uri);
1830 fields_error:
1831         free(a_fields);
1832 signature_error:
1833         free(a_sign);
1834         return len;
1835 }
1836
1837 /*
1838  * Returns 0 on success, negative error value on error.
1839  */
1840 int ustctl_reply_register_event(int sock,
1841         uint32_t id,
1842         int ret_code)
1843 {
1844         ssize_t len;
1845         struct {
1846                 struct ustcomm_notify_hdr header;
1847                 struct ustcomm_notify_event_reply r;
1848         } reply;
1849
1850         memset(&reply, 0, sizeof(reply));
1851         reply.header.notify_cmd = USTCTL_NOTIFY_CMD_EVENT;
1852         reply.r.ret_code = ret_code;
1853         reply.r.event_id = id;
1854         len = ustcomm_send_unix_sock(sock, &reply, sizeof(reply));
1855         if (len > 0 && len != sizeof(reply))
1856                 return -EIO;
1857         if (len < 0)
1858                 return len;
1859         return 0;
1860 }
1861
1862 /*
1863  * Returns 0 on success, negative UST or system error value on error.
1864  */
1865 int ustctl_recv_register_channel(int sock,
1866         int *session_objd,              /* session descriptor (output) */
1867         int *channel_objd,              /* channel descriptor (output) */
1868         size_t *nr_fields,
1869         struct ustctl_field **fields)
1870 {
1871         ssize_t len;
1872         struct ustcomm_notify_channel_msg msg;
1873         size_t fields_len;
1874         struct ustctl_field *a_fields;
1875
1876         len = ustcomm_recv_unix_sock(sock, &msg, sizeof(msg));
1877         if (len > 0 && len != sizeof(msg))
1878                 return -EIO;
1879         if (len == 0)
1880                 return -EPIPE;
1881         if (len < 0)
1882                 return len;
1883
1884         *session_objd = msg.session_objd;
1885         *channel_objd = msg.channel_objd;
1886         fields_len = msg.ctx_fields_len;
1887
1888         if (fields_len % sizeof(*a_fields) != 0) {
1889                 return -EINVAL;
1890         }
1891
1892         /* recv fields */
1893         if (fields_len) {
1894                 a_fields = zmalloc(fields_len);
1895                 if (!a_fields) {
1896                         len = -ENOMEM;
1897                         goto alloc_error;
1898                 }
1899                 len = ustcomm_recv_unix_sock(sock, a_fields, fields_len);
1900                 if (len > 0 && len != fields_len) {
1901                         len = -EIO;
1902                         goto fields_error;
1903                 }
1904                 if (len == 0) {
1905                         len = -EPIPE;
1906                         goto fields_error;
1907                 }
1908                 if (len < 0) {
1909                         goto fields_error;
1910                 }
1911                 *fields = a_fields;
1912         } else {
1913                 *fields = NULL;
1914         }
1915         *nr_fields = fields_len / sizeof(*a_fields);
1916         return 0;
1917
1918 fields_error:
1919         free(a_fields);
1920 alloc_error:
1921         return len;
1922 }
1923
1924 /*
1925  * Returns 0 on success, negative error value on error.
1926  */
1927 int ustctl_reply_register_channel(int sock,
1928         uint32_t chan_id,
1929         enum ustctl_channel_header header_type,
1930         int ret_code)
1931 {
1932         ssize_t len;
1933         struct {
1934                 struct ustcomm_notify_hdr header;
1935                 struct ustcomm_notify_channel_reply r;
1936         } reply;
1937
1938         memset(&reply, 0, sizeof(reply));
1939         reply.header.notify_cmd = USTCTL_NOTIFY_CMD_CHANNEL;
1940         reply.r.ret_code = ret_code;
1941         reply.r.chan_id = chan_id;
1942         switch (header_type) {
1943         case USTCTL_CHANNEL_HEADER_COMPACT:
1944                 reply.r.header_type = 1;
1945                 break;
1946         case USTCTL_CHANNEL_HEADER_LARGE:
1947                 reply.r.header_type = 2;
1948                 break;
1949         default:
1950                 reply.r.header_type = 0;
1951                 break;
1952         }
1953         len = ustcomm_send_unix_sock(sock, &reply, sizeof(reply));
1954         if (len > 0 && len != sizeof(reply))
1955                 return -EIO;
1956         if (len < 0)
1957                 return len;
1958         return 0;
1959 }
1960
1961 static __attribute__((constructor))
1962 void ustctl_init(void)
1963 {
1964         init_usterr();
1965         lttng_ring_buffer_metadata_client_init();
1966         lttng_ring_buffer_client_overwrite_init();
1967         lttng_ring_buffer_client_overwrite_rt_init();
1968         lttng_ring_buffer_client_discard_init();
1969         lttng_ring_buffer_client_discard_rt_init();
1970         lib_ringbuffer_signal_init();
1971 }
1972
1973 static __attribute__((destructor))
1974 void ustctl_exit(void)
1975 {
1976         lttng_ring_buffer_client_discard_rt_exit();
1977         lttng_ring_buffer_client_discard_exit();
1978         lttng_ring_buffer_client_overwrite_rt_exit();
1979         lttng_ring_buffer_client_overwrite_exit();
1980         lttng_ring_buffer_metadata_client_exit();
1981 }