src/common/kernel-ctl/kernel-ctl.c

   1 /*
   2  * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
   3  * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * SPDX-License-Identifier: GPL-2.0-only
   7  *
   8  */
   9
  10 #include "lttng/tracker.h"
  11 #define _LGPL_SOURCE
  12 #define __USE_LINUX_IOCTL_DEFS
  13 #include <sys/ioctl.h>
  14 #include <string.h>
  15 #include <common/align.h>
  16 #include <common/macros.h>
  17 #include <common/compat/errno.h>
  18 #include <stdarg.h>
  19 #include <assert.h>
  20 #include <common/time.h>
  21
  22 #include "kernel-ctl.h"
  23 #include "kernel-ioctl.h"
  24
  25 #define LTTNG_IOCTL_CHECK(fildes, request, ...)                         \
  26         ({                                                              \
  27                 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
  28                 assert(_ioctl_ret <= 0);                                \
  29                 !_ioctl_ret ? 0 : -errno;                               \
  30         })
  31
  32 #define LTTNG_IOCTL_NO_CHECK(fildes, request, ...)                      \
  33         ({                                                              \
  34                 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
  35                 _ioctl_ret >= 0 ? _ioctl_ret : -errno;                  \
  36         })
  37
  38 /*
  39  * This flag indicates which version of the kernel ABI to use. The old
  40  * ABI (namespace _old) does not support a 32-bit user-space when the
  41  * kernel is 64-bit. The old ABI is kept here for compatibility but is
  42  * deprecated and will be removed eventually.
  43  */
  44 static int lttng_kernel_use_old_abi = -1;
  45
  46 /*
  47  * Execute the new or old ioctl depending on the ABI version.
  48  * If the ABI version is not determined yet (lttng_kernel_use_old_abi = -1),
  49  * this function tests if the new ABI is available and otherwise fallbacks
  50  * on the old one.
  51  * This function takes the fd on which the ioctl must be executed and the old
  52  * and new request codes.
  53  * It returns the return value of the ioctl executed.
  54  */
  55 static inline int compat_ioctl_no_arg(int fd, unsigned long oldname,
  56                 unsigned long newname)
  57 {
  58         int ret;
  59
  60         if (lttng_kernel_use_old_abi == -1) {
  61                 ret = LTTNG_IOCTL_NO_CHECK(fd, newname);
  62                 if (!ret) {
  63                         lttng_kernel_use_old_abi = 0;
  64                         goto end;
  65                 }
  66                 lttng_kernel_use_old_abi = 1;
  67         }
  68         if (lttng_kernel_use_old_abi) {
  69                 ret = LTTNG_IOCTL_NO_CHECK(fd, oldname);
  70         } else {
  71                 ret = LTTNG_IOCTL_NO_CHECK(fd, newname);
  72         }
  73
  74 end:
  75         return ret;
  76 }
  77
  78 int kernctl_create_session(int fd)
  79 {
  80         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_SESSION,
  81                         LTTNG_KERNEL_SESSION);
  82 }
  83
  84 /* open the metadata global channel */
  85 int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops)
  86 {
  87         struct lttng_kernel_channel channel;
  88
  89         if (lttng_kernel_use_old_abi) {
  90                 struct lttng_kernel_old_channel old_channel;
  91
  92                 memset(&old_channel, 0, sizeof(old_channel));
  93                 old_channel.overwrite = chops->overwrite;
  94                 old_channel.subbuf_size = chops->subbuf_size;
  95                 old_channel.num_subbuf = chops->num_subbuf;
  96                 old_channel.switch_timer_interval = chops->switch_timer_interval;
  97                 old_channel.read_timer_interval = chops->read_timer_interval;
  98                 old_channel.output = chops->output;
  99
 100                 memset(old_channel.padding, 0, sizeof(old_channel.padding));
 101                 /*
 102                  * The new channel padding is smaller than the old ABI so we use the
 103                  * new ABI padding size for the memcpy.
 104                  */
 105                 memcpy(old_channel.padding, chops->padding, sizeof(chops->padding));
 106
 107                 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_OLD_METADATA,
 108                                 &old_channel);
 109         }
 110
 111         memset(&channel, 0, sizeof(channel));
 112         channel.overwrite = chops->overwrite;
 113         channel.subbuf_size = chops->subbuf_size;
 114         channel.num_subbuf = chops->num_subbuf;
 115         channel.switch_timer_interval = chops->switch_timer_interval;
 116         channel.read_timer_interval = chops->read_timer_interval;
 117         channel.output = chops->output;
 118         memcpy(channel.padding, chops->padding, sizeof(chops->padding));
 119
 120         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_METADATA, &channel);
 121 }
 122
 123 int kernctl_create_channel(int fd, struct lttng_channel_attr *chops)
 124 {
 125         struct lttng_kernel_channel channel;
 126
 127         memset(&channel, 0, sizeof(channel));
 128         if (lttng_kernel_use_old_abi) {
 129                 struct lttng_kernel_old_channel old_channel;
 130
 131                 old_channel.overwrite = chops->overwrite;
 132                 old_channel.subbuf_size = chops->subbuf_size;
 133                 old_channel.num_subbuf = chops->num_subbuf;
 134                 old_channel.switch_timer_interval = chops->switch_timer_interval;
 135                 old_channel.read_timer_interval = chops->read_timer_interval;
 136                 old_channel.output = chops->output;
 137
 138                 memset(old_channel.padding, 0, sizeof(old_channel.padding));
 139                 /*
 140                  * The new channel padding is smaller than the old ABI so we use the
 141                  * new ABI padding size for the memcpy.
 142                  */
 143                 memcpy(old_channel.padding, chops->padding, sizeof(chops->padding));
 144
 145                 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_OLD_CHANNEL,
 146                                 &old_channel);
 147         }
 148
 149         channel.overwrite = chops->overwrite;
 150         channel.subbuf_size = chops->subbuf_size;
 151         channel.num_subbuf = chops->num_subbuf;
 152         channel.switch_timer_interval = chops->switch_timer_interval;
 153         channel.read_timer_interval = chops->read_timer_interval;
 154         channel.output = chops->output;
 155         memcpy(channel.padding, chops->padding, sizeof(chops->padding));
 156
 157         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_CHANNEL, &channel);
 158 }
 159
 160 int kernctl_syscall_mask(int fd, char **syscall_mask, uint32_t *nr_bits)
 161 {
 162         struct lttng_kernel_syscall_mask kmask_len, *kmask = NULL;
 163         size_t array_alloc_len;
 164         char *new_mask;
 165         int ret = 0;
 166
 167         if (!syscall_mask) {
 168                 ret = -1;
 169                 goto end;
 170         }
 171
 172         if (!nr_bits) {
 173                 ret = -1;
 174                 goto end;
 175         }
 176
 177         kmask_len.len = 0;
 178         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SYSCALL_MASK, &kmask_len);
 179         if (ret) {
 180                 goto end;
 181         }
 182
 183         array_alloc_len = ALIGN(kmask_len.len, 8) >> 3;
 184
 185         kmask = zmalloc(sizeof(*kmask) + array_alloc_len);
 186         if (!kmask) {
 187                 ret = -1;
 188                 goto end;
 189         }
 190
 191         kmask->len = kmask_len.len;
 192         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SYSCALL_MASK, kmask);
 193         if (ret) {
 194                 goto end;
 195         }
 196
 197         new_mask = realloc(*syscall_mask, array_alloc_len);
 198         if (!new_mask) {
 199                 ret = -1;
 200                 goto end;
 201         }
 202         memcpy(new_mask, kmask->mask, array_alloc_len);
 203         *syscall_mask = new_mask;
 204         *nr_bits = kmask->len;
 205
 206 end:
 207         free(kmask);
 208         return ret;
 209 }
 210
 211 int kernctl_track_pid(int fd, int pid)
 212 {
 213         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_TRACK_PID, pid);
 214 }
 215
 216 int kernctl_untrack_pid(int fd, int pid)
 217 {
 218         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_UNTRACK_PID, pid);
 219 }
 220
 221 int kernctl_list_tracker_pids(int fd)
 222 {
 223         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS);
 224 }
 225
 226 static enum lttng_kernel_tracker_type get_kernel_tracker_type(
 227                 enum lttng_process_attr process_attr)
 228 {
 229         switch (process_attr) {
 230         case LTTNG_PROCESS_ATTR_PROCESS_ID:
 231                 return LTTNG_KERNEL_TRACKER_PID;
 232         case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID:
 233                 return LTTNG_KERNEL_TRACKER_VPID;
 234         case LTTNG_PROCESS_ATTR_USER_ID:
 235                 return LTTNG_KERNEL_TRACKER_UID;
 236         case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID:
 237                 return LTTNG_KERNEL_TRACKER_VUID;
 238         case LTTNG_PROCESS_ATTR_GROUP_ID:
 239                 return LTTNG_KERNEL_TRACKER_GID;
 240         case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID:
 241                 return LTTNG_KERNEL_TRACKER_VGID;
 242         default:
 243                 return LTTNG_KERNEL_TRACKER_UNKNOWN;
 244         }
 245 }
 246
 247 int kernctl_track_id(int fd, enum lttng_process_attr process_attr, int id)
 248 {
 249         struct lttng_kernel_tracker_args args;
 250
 251         args.id = id;
 252         args.type = get_kernel_tracker_type(process_attr);
 253         if (args.type == LTTNG_KERNEL_TRACKER_UNKNOWN) {
 254                 errno = EINVAL;
 255                 return -1;
 256         }
 257         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_TRACK_ID, &args);
 258 }
 259
 260 int kernctl_untrack_id(int fd, enum lttng_process_attr process_attr, int id)
 261 {
 262         struct lttng_kernel_tracker_args args;
 263
 264         args.id = id;
 265         args.type = get_kernel_tracker_type(process_attr);
 266         if (args.type == LTTNG_KERNEL_TRACKER_UNKNOWN) {
 267                 errno = EINVAL;
 268                 return -1;
 269         }
 270         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_UNTRACK_ID, &args);
 271 }
 272
 273 int kernctl_list_tracker_ids(int fd, enum lttng_process_attr process_attr)
 274 {
 275         struct lttng_kernel_tracker_args args;
 276
 277         args.id = -1;
 278         args.type = get_kernel_tracker_type(process_attr);
 279         if (args.type == LTTNG_KERNEL_TRACKER_UNKNOWN) {
 280                 errno = EINVAL;
 281                 return -1;
 282         }
 283         return LTTNG_IOCTL_NO_CHECK(
 284                         fd, LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS, &args);
 285 }
 286
 287 int kernctl_session_regenerate_metadata(int fd)
 288 {
 289         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_METADATA_REGEN);
 290 }
 291
 292 int kernctl_session_regenerate_statedump(int fd)
 293 {
 294         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_STATEDUMP);
 295 }
 296
 297 int kernctl_session_set_name(int fd, const char *name)
 298 {
 299         int ret;
 300         struct lttng_kernel_session_name session_name;
 301
 302         ret = lttng_strncpy(session_name.name, name, sizeof(session_name.name));
 303         if (ret) {
 304                 goto end;
 305         }
 306
 307         ret = LTTNG_IOCTL_CHECK(
 308                         fd, LTTNG_KERNEL_SESSION_SET_NAME, &session_name);
 309 end:
 310         return ret;
 311 }
 312
 313 int kernctl_session_set_creation_time(int fd, time_t time)
 314 {
 315         int ret;
 316         struct lttng_kernel_session_creation_time creation_time;
 317
 318         ret = time_to_iso8601_str(time, creation_time.iso8601,
 319                         sizeof(creation_time.iso8601));
 320         if (ret) {
 321                 goto end;
 322         }
 323
 324         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_SET_CREATION_TIME,
 325                         &creation_time);
 326 end:
 327         return ret;
 328 }
 329
 330 int kernctl_create_stream(int fd)
 331 {
 332         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_STREAM,
 333                         LTTNG_KERNEL_STREAM);
 334 }
 335
 336 int kernctl_create_event(int fd, struct lttng_kernel_event *ev)
 337 {
 338         if (lttng_kernel_use_old_abi) {
 339                 struct lttng_kernel_old_event old_event;
 340
 341                 memset(&old_event, 0, sizeof(old_event));
 342                 memcpy(old_event.name, ev->name, sizeof(old_event.name));
 343                 old_event.instrumentation = ev->instrumentation;
 344                 switch (ev->instrumentation) {
 345                 case LTTNG_KERNEL_KPROBE:
 346                         old_event.u.kprobe.addr = ev->u.kprobe.addr;
 347                         old_event.u.kprobe.offset = ev->u.kprobe.offset;
 348                         memcpy(old_event.u.kprobe.symbol_name,
 349                                 ev->u.kprobe.symbol_name,
 350                                 sizeof(old_event.u.kprobe.symbol_name));
 351                         break;
 352                 case LTTNG_KERNEL_KRETPROBE:
 353                         old_event.u.kretprobe.addr = ev->u.kretprobe.addr;
 354                         old_event.u.kretprobe.offset = ev->u.kretprobe.offset;
 355                         memcpy(old_event.u.kretprobe.symbol_name,
 356                                 ev->u.kretprobe.symbol_name,
 357                                 sizeof(old_event.u.kretprobe.symbol_name));
 358                         break;
 359                 case LTTNG_KERNEL_FUNCTION:
 360                         memcpy(old_event.u.ftrace.symbol_name,
 361                                         ev->u.ftrace.symbol_name,
 362                                         sizeof(old_event.u.ftrace.symbol_name));
 363                         break;
 364                 default:
 365                         break;
 366                 }
 367
 368                 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_OLD_EVENT,
 369                                 &old_event);
 370         }
 371         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_EVENT, ev);
 372 }
 373
 374 int kernctl_add_context(int fd, struct lttng_kernel_context *ctx)
 375 {
 376         if (lttng_kernel_use_old_abi) {
 377                 struct lttng_kernel_old_context old_ctx;
 378
 379                 memset(&old_ctx, 0, sizeof(old_ctx));
 380                 old_ctx.ctx = ctx->ctx;
 381                 /* only type that uses the union */
 382                 if (ctx->ctx == LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER) {
 383                         old_ctx.u.perf_counter.type =
 384                                 ctx->u.perf_counter.type;
 385                         old_ctx.u.perf_counter.config =
 386                                 ctx->u.perf_counter.config;
 387                         memcpy(old_ctx.u.perf_counter.name,
 388                                 ctx->u.perf_counter.name,
 389                                 sizeof(old_ctx.u.perf_counter.name));
 390                 }
 391                 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_OLD_CONTEXT, &old_ctx);
 392         }
 393         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_CONTEXT, ctx);
 394 }
 395
 396
 397 /* Enable event, channel and session LTTNG_IOCTL_CHECK */
 398 int kernctl_enable(int fd)
 399 {
 400         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_ENABLE,
 401                         LTTNG_KERNEL_ENABLE);
 402 }
 403
 404 /* Disable event, channel and session LTTNG_IOCTL_CHECK */
 405 int kernctl_disable(int fd)
 406 {
 407         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_DISABLE,
 408                         LTTNG_KERNEL_DISABLE);
 409 }
 410
 411 int kernctl_start_session(int fd)
 412 {
 413         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_SESSION_START,
 414                         LTTNG_KERNEL_SESSION_START);
 415 }
 416
 417 int kernctl_stop_session(int fd)
 418 {
 419         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_SESSION_STOP,
 420                         LTTNG_KERNEL_SESSION_STOP);
 421 }
 422
 423 int kernctl_create_event_notifier_group(int fd)
 424 {
 425         return LTTNG_IOCTL_NO_CHECK(fd,
 426                         LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_CREATE);
 427 }
 428
 429 int kernctl_create_event_notifier_group_notification_fd(int group_fd)
 430 {
 431         return LTTNG_IOCTL_NO_CHECK(group_fd,
 432                         LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD);
 433 }
 434
 435 int kernctl_create_event_notifier_group_error_counter(int group_fd,
 436                 const struct lttng_kernel_counter_conf *error_counter_conf)
 437 {
 438         return LTTNG_IOCTL_NO_CHECK(group_fd, LTTNG_KERNEL_COUNTER,
 439                         error_counter_conf);
 440 }
 441
 442 int kernctl_counter_get_aggregate_value(int counter_fd,
 443                 struct lttng_kernel_counter_aggregate *value)
 444 {
 445         return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_COUNTER_AGGREGATE,
 446                         value);
 447 }
 448
 449 int kernctl_counter_clear(int counter_fd,
 450                 struct lttng_kernel_counter_clear *clear)
 451 {
 452         return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_COUNTER_CLEAR,
 453                         clear);
 454 }
 455
 456 int kernctl_create_event_notifier(int group_fd,
 457                 const struct lttng_kernel_event_notifier *event_notifier)
 458 {
 459         return LTTNG_IOCTL_NO_CHECK(group_fd,
 460                         LTTNG_KERNEL_EVENT_NOTIFIER_CREATE, event_notifier);
 461 }
 462
 463 int kernctl_capture(int fd, const struct lttng_bytecode *capture)
 464 {
 465         int ret;
 466         struct lttng_kernel_capture_bytecode *kb;
 467
 468         /* Translate bytecode to kernel bytecode. */
 469         kb = zmalloc(sizeof(*kb) + capture->len);
 470         if (!kb) {
 471                 ret = -ENOMEM;
 472                 goto end;
 473         }
 474
 475         kb->len = capture->len;
 476         kb->reloc_offset = capture->reloc_table_offset;
 477         kb->seqnum = capture->seqnum;
 478         memcpy(kb->data, capture->data, capture->len);
 479         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_CAPTURE, kb);
 480         free(kb);
 481 end:
 482         return ret;
 483 }
 484
 485 int kernctl_filter(int fd, const struct lttng_bytecode *filter)
 486 {
 487         struct lttng_kernel_filter_bytecode *kb;
 488         uint32_t len;
 489         int ret;
 490
 491         /* Translate bytecode to kernel bytecode */
 492         kb = zmalloc(sizeof(*kb) + filter->len);
 493         if (!kb)
 494                 return -ENOMEM;
 495         kb->len = len = filter->len;
 496         kb->reloc_offset = filter->reloc_table_offset;
 497         kb->seqnum = filter->seqnum;
 498         memcpy(kb->data, filter->data, len);
 499         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_FILTER, kb);
 500         free(kb);
 501         return ret;
 502 }
 503
 504 int kernctl_add_callsite(int fd, struct lttng_kernel_event_callsite *callsite)
 505 {
 506         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ADD_CALLSITE, callsite);
 507 }
 508
 509 int kernctl_tracepoint_list(int fd)
 510 {
 511         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_TRACEPOINT_LIST,
 512                         LTTNG_KERNEL_TRACEPOINT_LIST);
 513 }
 514
 515 int kernctl_syscall_list(int fd)
 516 {
 517         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_SYSCALL_LIST);
 518 }
 519
 520 int kernctl_tracer_version(int fd, struct lttng_kernel_tracer_version *v)
 521 {
 522         int ret;
 523
 524         if (lttng_kernel_use_old_abi == -1) {
 525                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_TRACER_VERSION, v);
 526                 if (!ret) {
 527                         lttng_kernel_use_old_abi = 0;
 528                         goto end;
 529                 }
 530                 lttng_kernel_use_old_abi = 1;
 531         }
 532         if (lttng_kernel_use_old_abi) {
 533                 struct lttng_kernel_old_tracer_version old_v;
 534
 535                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_OLD_TRACER_VERSION, &old_v);
 536                 if (ret) {
 537                         goto end;
 538                 }
 539                 v->major = old_v.major;
 540                 v->minor = old_v.minor;
 541                 v->patchlevel = old_v.patchlevel;
 542         } else {
 543                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_TRACER_VERSION, v);
 544         }
 545
 546 end:
 547         return ret;
 548 }
 549
 550 int kernctl_tracer_abi_version(int fd,
 551                 struct lttng_kernel_tracer_abi_version *v)
 552 {
 553         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_TRACER_ABI_VERSION, v);
 554 }
 555
 556 int kernctl_wait_quiescent(int fd)
 557 {
 558         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_WAIT_QUIESCENT,
 559                         LTTNG_KERNEL_WAIT_QUIESCENT);
 560 }
 561
 562 int kernctl_buffer_flush(int fd)
 563 {
 564         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_FLUSH);
 565 }
 566
 567 int kernctl_buffer_flush_empty(int fd)
 568 {
 569         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_FLUSH_EMPTY);
 570 }
 571
 572 int kernctl_buffer_clear(int fd)
 573 {
 574         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_CLEAR);
 575 }
 576
 577 int kernctl_get_next_subbuf_metadata_check(int fd, bool *consistent)
 578 {
 579         return LTTNG_IOCTL_NO_CHECK(fd,
 580                         RING_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK,
 581                         consistent);
 582 }
 583
 584 /* returns the version of the metadata. */
 585 int kernctl_get_metadata_version(int fd, uint64_t *version)
 586 {
 587         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_METADATA_VERSION, version);
 588 }
 589
 590 int kernctl_metadata_cache_dump(int fd)
 591 {
 592         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_METADATA_CACHE_DUMP);
 593 }
 594
 595 /* Buffer operations */
 596
 597 /* For mmap mode, readable without "get" operation */
 598
 599 /* returns the length to mmap. */
 600 int kernctl_get_mmap_len(int fd, unsigned long *len)
 601 {
 602         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_MMAP_LEN, len);
 603 }
 604
 605 /* returns the maximum size for sub-buffers. */
 606 int kernctl_get_max_subbuf_size(int fd, unsigned long *len)
 607 {
 608         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_MAX_SUBBUF_SIZE, len);
 609 }
 610
 611 /*
 612  * For mmap mode, operate on the current packet (between get/put or
 613  * get_next/put_next).
 614  */
 615
 616 /* returns the offset of the subbuffer belonging to the mmap reader. */
 617 int kernctl_get_mmap_read_offset(int fd, unsigned long *off)
 618 {
 619         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_MMAP_READ_OFFSET, off);
 620 }
 621
 622 /* returns the size of the current sub-buffer, without padding (for mmap). */
 623 int kernctl_get_subbuf_size(int fd, unsigned long *len)
 624 {
 625         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_SUBBUF_SIZE, len);
 626 }
 627
 628 /* returns the size of the current sub-buffer, without padding (for mmap). */
 629 int kernctl_get_padded_subbuf_size(int fd, unsigned long *len)
 630 {
 631         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_PADDED_SUBBUF_SIZE, len);
 632 }
 633
 634 /* Get exclusive read access to the next sub-buffer that can be read. */
 635 int kernctl_get_next_subbuf(int fd)
 636 {
 637         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_NEXT_SUBBUF);
 638 }
 639
 640
 641 /* Release exclusive sub-buffer access, move consumer forward. */
 642 int kernctl_put_next_subbuf(int fd)
 643 {
 644         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_PUT_NEXT_SUBBUF);
 645 }
 646
 647 /* snapshot */
 648
 649 /* Get a snapshot of the current ring buffer producer and consumer positions */
 650 int kernctl_snapshot(int fd)
 651 {
 652         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT);
 653 }
 654
 655 /*
 656  * Get a snapshot of the current ring buffer producer and consumer positions,
 657  * regardless of whether or not the two positions are contained within the
 658  * same sub-buffer.
 659  */
 660 int kernctl_snapshot_sample_positions(int fd)
 661 {
 662         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS);
 663 }
 664
 665 /* Get the consumer position (iteration start) */
 666 int kernctl_snapshot_get_consumed(int fd, unsigned long *pos)
 667 {
 668         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT_GET_CONSUMED, pos);
 669 }
 670
 671 /* Get the producer position (iteration end) */
 672 int kernctl_snapshot_get_produced(int fd, unsigned long *pos)
 673 {
 674         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT_GET_PRODUCED, pos);
 675 }
 676
 677 /* Get exclusive read access to the specified sub-buffer position */
 678 int kernctl_get_subbuf(int fd, unsigned long *len)
 679 {
 680         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_SUBBUF, len);
 681 }
 682
 683 /* Release exclusive sub-buffer access */
 684 int kernctl_put_subbuf(int fd)
 685 {
 686         return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_PUT_SUBBUF);
 687 }
 688
 689 /* Returns the timestamp begin of the current sub-buffer. */
 690 int kernctl_get_timestamp_begin(int fd, uint64_t *timestamp_begin)
 691 {
 692         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN,
 693                         timestamp_begin);
 694 }
 695
 696 /* Returns the timestamp end of the current sub-buffer. */
 697 int kernctl_get_timestamp_end(int fd, uint64_t *timestamp_end)
 698 {
 699         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_TIMESTAMP_END,
 700                         timestamp_end);
 701 }
 702
 703 /* Returns the number of discarded events in the current sub-buffer. */
 704 int kernctl_get_events_discarded(int fd, uint64_t *events_discarded)
 705 {
 706         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED,
 707                         events_discarded);
 708 }
 709
 710 /* Returns the content size in the current sub-buffer. */
 711 int kernctl_get_content_size(int fd, uint64_t *content_size)
 712 {
 713         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_CONTENT_SIZE,
 714                         content_size);
 715 }
 716
 717 /* Returns the packet size in the current sub-buffer. */
 718 int kernctl_get_packet_size(int fd, uint64_t *packet_size)
 719 {
 720         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_PACKET_SIZE,
 721                         packet_size);
 722 }
 723
 724 /* Returns the stream id of the current sub-buffer. */
 725 int kernctl_get_stream_id(int fd, uint64_t *stream_id)
 726 {
 727         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_STREAM_ID,
 728                         stream_id);
 729 }
 730
 731 /* Returns the current timestamp. */
 732 int kernctl_get_current_timestamp(int fd, uint64_t *ts)
 733 {
 734         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP,
 735                         ts);
 736 }
 737
 738 /* Returns the packet sequence number of the current sub-buffer. */
 739 int kernctl_get_sequence_number(int fd, uint64_t *seq)
 740 {
 741         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_SEQ_NUM, seq);
 742 }
 743
 744 /* Returns the stream instance id. */
 745 int kernctl_get_instance_id(int fd, uint64_t *id)
 746 {
 747         return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_INSTANCE_ID, id);
 748 }