src/common/kernel-ctl/kernel-ctl.cpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   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 "kernel-ctl.hpp"
  14 #include "kernel-ioctl.hpp"
  15
  16 #include <common/align.hpp>
  17 #include <common/compat/errno.hpp>
  18 #include <common/macros.hpp>
  19 #include <common/time.hpp>
  20
  21 #include <stdarg.h>
  22 #include <string.h>
  23 #include <sys/ioctl.h>
  24
  25 #define LTTNG_IOCTL_CHECK(fildes, request, ...)                         \
  26         ({                                                              \
  27                 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
  28                 LTTNG_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_abi_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_abi_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, unsigned long newname)
  56 {
  57         int ret;
  58
  59         if (lttng_kernel_abi_use_old_abi == -1) {
  60                 ret = LTTNG_IOCTL_NO_CHECK(fd, newname);
  61                 if (!ret) {
  62                         lttng_kernel_abi_use_old_abi = 0;
  63                         goto end;
  64                 }
  65                 lttng_kernel_abi_use_old_abi = 1;
  66         }
  67         if (lttng_kernel_abi_use_old_abi) {
  68                 ret = LTTNG_IOCTL_NO_CHECK(fd, oldname);
  69         } else {
  70                 ret = LTTNG_IOCTL_NO_CHECK(fd, newname);
  71         }
  72
  73 end:
  74         return ret;
  75 }
  76
  77 int kernctl_create_session(int fd)
  78 {
  79         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_ABI_OLD_SESSION, LTTNG_KERNEL_ABI_SESSION);
  80 }
  81
  82 /* open the metadata global channel */
  83 int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops)
  84 {
  85         struct lttng_kernel_abi_channel channel;
  86
  87         if (lttng_kernel_abi_use_old_abi) {
  88                 struct lttng_kernel_abi_old_channel old_channel;
  89
  90                 memset(&old_channel, 0, sizeof(old_channel));
  91                 old_channel.overwrite = chops->overwrite;
  92                 old_channel.subbuf_size = chops->subbuf_size;
  93                 old_channel.num_subbuf = chops->num_subbuf;
  94                 old_channel.switch_timer_interval = chops->switch_timer_interval;
  95                 old_channel.read_timer_interval = chops->read_timer_interval;
  96                 old_channel.output = chops->output;
  97
  98                 memset(old_channel.padding, 0, sizeof(old_channel.padding));
  99                 /*
 100                  * The new channel padding is smaller than the old ABI so we use the
 101                  * new ABI padding size for the memcpy.
 102                  */
 103                 memcpy(old_channel.padding, chops->padding, sizeof(chops->padding));
 104
 105                 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_OLD_METADATA, &old_channel);
 106         }
 107
 108         memset(&channel, 0, sizeof(channel));
 109         channel.overwrite = chops->overwrite;
 110         channel.subbuf_size = chops->subbuf_size;
 111         channel.num_subbuf = chops->num_subbuf;
 112         channel.switch_timer_interval = chops->switch_timer_interval;
 113         channel.read_timer_interval = chops->read_timer_interval;
 114         channel.output = chops->output;
 115         memcpy(channel.padding, chops->padding, sizeof(chops->padding));
 116
 117         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_METADATA, &channel);
 118 }
 119
 120 int kernctl_create_channel(int fd, struct lttng_channel_attr *chops)
 121 {
 122         struct lttng_kernel_abi_channel channel;
 123
 124         memset(&channel, 0, sizeof(channel));
 125         if (lttng_kernel_abi_use_old_abi) {
 126                 struct lttng_kernel_abi_old_channel old_channel;
 127
 128                 old_channel.overwrite = chops->overwrite;
 129                 old_channel.subbuf_size = chops->subbuf_size;
 130                 old_channel.num_subbuf = chops->num_subbuf;
 131                 old_channel.switch_timer_interval = chops->switch_timer_interval;
 132                 old_channel.read_timer_interval = chops->read_timer_interval;
 133                 old_channel.output = chops->output;
 134
 135                 memset(old_channel.padding, 0, sizeof(old_channel.padding));
 136                 /*
 137                  * The new channel padding is smaller than the old ABI so we use the
 138                  * new ABI padding size for the memcpy.
 139                  */
 140                 memcpy(old_channel.padding, chops->padding, sizeof(chops->padding));
 141
 142                 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_OLD_CHANNEL, &old_channel);
 143         }
 144
 145         channel.overwrite = chops->overwrite;
 146         channel.subbuf_size = chops->subbuf_size;
 147         channel.num_subbuf = chops->num_subbuf;
 148         channel.switch_timer_interval = chops->switch_timer_interval;
 149         channel.read_timer_interval = chops->read_timer_interval;
 150         channel.output = chops->output;
 151         memcpy(channel.padding, chops->padding, sizeof(chops->padding));
 152
 153         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_CHANNEL, &channel);
 154 }
 155
 156 int kernctl_syscall_mask(int fd, char **syscall_mask, uint32_t *nr_bits)
 157 {
 158         struct lttng_kernel_abi_syscall_mask kmask_len, *kmask = NULL;
 159         size_t array_alloc_len;
 160         char *new_mask;
 161         int ret = 0;
 162
 163         if (!syscall_mask) {
 164                 ret = -1;
 165                 goto end;
 166         }
 167
 168         if (!nr_bits) {
 169                 ret = -1;
 170                 goto end;
 171         }
 172
 173         kmask_len.len = 0;
 174         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SYSCALL_MASK, &kmask_len);
 175         if (ret) {
 176                 goto end;
 177         }
 178
 179         array_alloc_len = lttng_align_ceil(kmask_len.len, 8) >> 3;
 180
 181         kmask = zmalloc<lttng_kernel_abi_syscall_mask>(sizeof(*kmask) + array_alloc_len);
 182         if (!kmask) {
 183                 ret = -1;
 184                 goto end;
 185         }
 186
 187         kmask->len = kmask_len.len;
 188         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SYSCALL_MASK, kmask);
 189         if (ret) {
 190                 goto end;
 191         }
 192
 193         new_mask = (char *) realloc(*syscall_mask, array_alloc_len);
 194         if (!new_mask) {
 195                 ret = -1;
 196                 goto end;
 197         }
 198         memcpy(new_mask, kmask->mask, array_alloc_len);
 199         *syscall_mask = new_mask;
 200         *nr_bits = kmask->len;
 201
 202 end:
 203         free(kmask);
 204         return ret;
 205 }
 206
 207 int kernctl_track_pid(int fd, int pid)
 208 {
 209         int ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_TRACK_PID, pid);
 210
 211         if (ret == -ENOSYS) {
 212                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_PID, pid);
 213         }
 214
 215         return ret;
 216 }
 217
 218 int kernctl_untrack_pid(int fd, int pid)
 219 {
 220         int ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_UNTRACK_PID, pid);
 221
 222         if (ret == -ENOSYS) {
 223                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_PID, pid);
 224         }
 225
 226         return ret;
 227 }
 228
 229 int kernctl_list_tracker_pids(int fd)
 230 {
 231         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_PIDS);
 232 }
 233
 234 static enum lttng_kernel_abi_tracker_type
 235 get_kernel_tracker_type(enum lttng_process_attr process_attr)
 236 {
 237         switch (process_attr) {
 238         case LTTNG_PROCESS_ATTR_PROCESS_ID:
 239                 return LTTNG_KERNEL_ABI_TRACKER_PID;
 240         case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID:
 241                 return LTTNG_KERNEL_ABI_TRACKER_VPID;
 242         case LTTNG_PROCESS_ATTR_USER_ID:
 243                 return LTTNG_KERNEL_ABI_TRACKER_UID;
 244         case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID:
 245                 return LTTNG_KERNEL_ABI_TRACKER_VUID;
 246         case LTTNG_PROCESS_ATTR_GROUP_ID:
 247                 return LTTNG_KERNEL_ABI_TRACKER_GID;
 248         case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID:
 249                 return LTTNG_KERNEL_ABI_TRACKER_VGID;
 250         default:
 251                 return LTTNG_KERNEL_ABI_TRACKER_UNKNOWN;
 252         }
 253 }
 254
 255 int kernctl_track_id(int fd, enum lttng_process_attr process_attr, int id)
 256 {
 257         struct lttng_kernel_abi_tracker_args args;
 258         int ret;
 259
 260         args.id = id;
 261         args.type = get_kernel_tracker_type(process_attr);
 262         if (args.type == LTTNG_KERNEL_ABI_TRACKER_UNKNOWN) {
 263                 errno = EINVAL;
 264                 return -1;
 265         }
 266
 267         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_TRACK_ID, &args);
 268         if (ret == -ENOSYS) {
 269                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_ID, &args);
 270         }
 271
 272         return ret;
 273 }
 274
 275 int kernctl_untrack_id(int fd, enum lttng_process_attr process_attr, int id)
 276 {
 277         struct lttng_kernel_abi_tracker_args args;
 278         int ret;
 279
 280         args.id = id;
 281         args.type = get_kernel_tracker_type(process_attr);
 282         if (args.type == LTTNG_KERNEL_ABI_TRACKER_UNKNOWN) {
 283                 errno = EINVAL;
 284                 return -1;
 285         }
 286
 287         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_UNTRACK_ID, &args);
 288         if (ret == -ENOSYS) {
 289                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_ID, &args);
 290         }
 291
 292         return ret;
 293 }
 294
 295 int kernctl_list_tracker_ids(int fd, enum lttng_process_attr process_attr)
 296 {
 297         struct lttng_kernel_abi_tracker_args args;
 298         int ret;
 299
 300         args.id = -1;
 301         args.type = get_kernel_tracker_type(process_attr);
 302         if (args.type == LTTNG_KERNEL_ABI_TRACKER_UNKNOWN) {
 303                 errno = EINVAL;
 304                 return -1;
 305         }
 306
 307         ret = LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_IDS, &args);
 308         if (ret == -ENOSYS) {
 309                 ret = LTTNG_IOCTL_NO_CHECK(
 310                         fd, LTTNG_KERNEL_ABI_OLD_SESSION_LIST_TRACKER_IDS, &args);
 311         }
 312
 313         return ret;
 314 }
 315
 316 int kernctl_session_regenerate_metadata(int fd)
 317 {
 318         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_METADATA_REGEN);
 319 }
 320
 321 int kernctl_session_regenerate_statedump(int fd)
 322 {
 323         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_STATEDUMP);
 324 }
 325
 326 int kernctl_session_set_name(int fd, const char *name)
 327 {
 328         int ret;
 329         struct lttng_kernel_abi_session_name session_name;
 330
 331         ret = lttng_strncpy(session_name.name, name, sizeof(session_name.name));
 332         if (ret) {
 333                 goto end;
 334         }
 335
 336         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_SET_NAME, &session_name);
 337         if (ret == -ENOSYS) {
 338                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_SESSION_SET_NAME, &session_name);
 339         }
 340
 341 end:
 342         return ret;
 343 }
 344
 345 int kernctl_session_set_creation_time(int fd, time_t time)
 346 {
 347         int ret;
 348         struct lttng_kernel_abi_session_creation_time creation_time;
 349
 350         ret = time_to_iso8601_str(time, creation_time.iso8601, sizeof(creation_time.iso8601));
 351         if (ret) {
 352                 goto end;
 353         }
 354
 355         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_SESSION_SET_CREATION_TIME, &creation_time);
 356         if (ret == -ENOSYS) {
 357                 ret = LTTNG_IOCTL_CHECK(
 358                         fd, LTTNG_KERNEL_ABI_OLD_SESSION_SET_CREATION_TIME, &creation_time);
 359         }
 360
 361 end:
 362         return ret;
 363 }
 364
 365 int kernctl_create_stream(int fd)
 366 {
 367         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_ABI_OLD_STREAM, LTTNG_KERNEL_ABI_STREAM);
 368 }
 369
 370 int kernctl_create_event(int fd, struct lttng_kernel_abi_event *ev)
 371 {
 372         if (lttng_kernel_abi_use_old_abi) {
 373                 struct lttng_kernel_abi_old_event old_event;
 374
 375                 memset(&old_event, 0, sizeof(old_event));
 376                 memcpy(old_event.name, ev->name, sizeof(old_event.name));
 377                 old_event.instrumentation = ev->instrumentation;
 378                 switch (ev->instrumentation) {
 379                 case LTTNG_KERNEL_ABI_KPROBE:
 380                         old_event.u.kprobe.addr = ev->u.kprobe.addr;
 381                         old_event.u.kprobe.offset = ev->u.kprobe.offset;
 382                         memcpy(old_event.u.kprobe.symbol_name,
 383                                ev->u.kprobe.symbol_name,
 384                                sizeof(old_event.u.kprobe.symbol_name));
 385                         break;
 386                 case LTTNG_KERNEL_ABI_KRETPROBE:
 387                         old_event.u.kretprobe.addr = ev->u.kretprobe.addr;
 388                         old_event.u.kretprobe.offset = ev->u.kretprobe.offset;
 389                         memcpy(old_event.u.kretprobe.symbol_name,
 390                                ev->u.kretprobe.symbol_name,
 391                                sizeof(old_event.u.kretprobe.symbol_name));
 392                         break;
 393                 case LTTNG_KERNEL_ABI_FUNCTION:
 394                         memcpy(old_event.u.ftrace.symbol_name,
 395                                ev->u.ftrace.symbol_name,
 396                                sizeof(old_event.u.ftrace.symbol_name));
 397                         break;
 398                 default:
 399                         break;
 400                 }
 401
 402                 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_OLD_EVENT, &old_event);
 403         }
 404         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_EVENT, ev);
 405 }
 406
 407 int kernctl_add_context(int fd, struct lttng_kernel_abi_context *ctx)
 408 {
 409         if (lttng_kernel_abi_use_old_abi) {
 410                 struct lttng_kernel_abi_old_context old_ctx;
 411
 412                 memset(&old_ctx, 0, sizeof(old_ctx));
 413                 old_ctx.ctx = ctx->ctx;
 414                 /* only type that uses the union */
 415                 if (ctx->ctx == LTTNG_KERNEL_ABI_CONTEXT_PERF_CPU_COUNTER) {
 416                         old_ctx.u.perf_counter.type = ctx->u.perf_counter.type;
 417                         old_ctx.u.perf_counter.config = ctx->u.perf_counter.config;
 418                         memcpy(old_ctx.u.perf_counter.name,
 419                                ctx->u.perf_counter.name,
 420                                sizeof(old_ctx.u.perf_counter.name));
 421                 }
 422                 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_CONTEXT, &old_ctx);
 423         }
 424         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_CONTEXT, ctx);
 425 }
 426
 427 /* Enable event, channel and session LTTNG_IOCTL_CHECK */
 428 int kernctl_enable(int fd)
 429 {
 430         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_ABI_OLD_ENABLE, LTTNG_KERNEL_ABI_ENABLE);
 431 }
 432
 433 /* Disable event, channel and session LTTNG_IOCTL_CHECK */
 434 int kernctl_disable(int fd)
 435 {
 436         return compat_ioctl_no_arg(fd, LTTNG_KERNEL_ABI_OLD_DISABLE, LTTNG_KERNEL_ABI_DISABLE);
 437 }
 438
 439 int kernctl_start_session(int fd)
 440 {
 441         return compat_ioctl_no_arg(
 442                 fd, LTTNG_KERNEL_ABI_OLD_SESSION_START, LTTNG_KERNEL_ABI_SESSION_START);
 443 }
 444
 445 int kernctl_stop_session(int fd)
 446 {
 447         return compat_ioctl_no_arg(
 448                 fd, LTTNG_KERNEL_ABI_OLD_SESSION_STOP, LTTNG_KERNEL_ABI_SESSION_STOP);
 449 }
 450
 451 int kernctl_create_event_notifier_group(int fd)
 452 {
 453         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_CREATE);
 454 }
 455
 456 int kernctl_create_event_notifier_group_notification_fd(int group_fd)
 457 {
 458         return LTTNG_IOCTL_NO_CHECK(group_fd,
 459                                     LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD);
 460 }
 461
 462 int kernctl_create_event_notifier_group_error_counter(
 463         int group_fd, const struct lttng_kernel_abi_counter_conf *error_counter_conf)
 464 {
 465         return LTTNG_IOCTL_NO_CHECK(group_fd, LTTNG_KERNEL_ABI_COUNTER, error_counter_conf);
 466 }
 467
 468 int kernctl_counter_get_aggregate_value(int counter_fd,
 469                                         struct lttng_kernel_abi_counter_aggregate *value)
 470 {
 471         return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_ABI_COUNTER_AGGREGATE, value);
 472 }
 473
 474 int kernctl_counter_clear(int counter_fd, struct lttng_kernel_abi_counter_clear *clear)
 475 {
 476         return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_ABI_COUNTER_CLEAR, clear);
 477 }
 478
 479 int kernctl_create_event_notifier(int group_fd,
 480                                   const struct lttng_kernel_abi_event_notifier *event_notifier)
 481 {
 482         return LTTNG_IOCTL_NO_CHECK(
 483                 group_fd, LTTNG_KERNEL_ABI_EVENT_NOTIFIER_CREATE, event_notifier);
 484 }
 485
 486 int kernctl_capture(int fd, const struct lttng_bytecode *capture)
 487 {
 488         int ret;
 489         struct lttng_kernel_abi_capture_bytecode *kb;
 490
 491         /* Translate bytecode to kernel bytecode. */
 492         kb = zmalloc<lttng_kernel_abi_capture_bytecode>(sizeof(*kb) + capture->len);
 493         if (!kb) {
 494                 ret = -ENOMEM;
 495                 goto end;
 496         }
 497
 498         kb->len = capture->len;
 499         kb->reloc_offset = capture->reloc_table_offset;
 500         kb->seqnum = capture->seqnum;
 501         memcpy(kb->data, capture->data, capture->len);
 502         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_CAPTURE, kb);
 503         free(kb);
 504 end:
 505         return ret;
 506 }
 507
 508 int kernctl_filter(int fd, const struct lttng_bytecode *filter)
 509 {
 510         struct lttng_kernel_abi_filter_bytecode *kb;
 511         uint32_t len;
 512         int ret;
 513
 514         /* Translate bytecode to kernel bytecode */
 515         kb = zmalloc<lttng_kernel_abi_filter_bytecode>(sizeof(*kb) + filter->len);
 516         if (!kb)
 517                 return -ENOMEM;
 518         kb->len = len = filter->len;
 519         kb->reloc_offset = filter->reloc_table_offset;
 520         kb->seqnum = filter->seqnum;
 521         memcpy(kb->data, filter->data, len);
 522         ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_FILTER, kb);
 523         free(kb);
 524         return ret;
 525 }
 526
 527 int kernctl_add_callsite(int fd, struct lttng_kernel_abi_event_callsite *callsite)
 528 {
 529         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_ADD_CALLSITE, callsite);
 530 }
 531
 532 int kernctl_tracepoint_list(int fd)
 533 {
 534         return compat_ioctl_no_arg(
 535                 fd, LTTNG_KERNEL_ABI_OLD_TRACEPOINT_LIST, LTTNG_KERNEL_ABI_TRACEPOINT_LIST);
 536 }
 537
 538 int kernctl_syscall_list(int fd)
 539 {
 540         return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_ABI_SYSCALL_LIST);
 541 }
 542
 543 int kernctl_tracer_version(int fd, struct lttng_kernel_abi_tracer_version *v)
 544 {
 545         int ret;
 546
 547         if (lttng_kernel_abi_use_old_abi == -1) {
 548                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_TRACER_VERSION, v);
 549                 if (!ret) {
 550                         lttng_kernel_abi_use_old_abi = 0;
 551                         goto end;
 552                 }
 553                 lttng_kernel_abi_use_old_abi = 1;
 554         }
 555         if (lttng_kernel_abi_use_old_abi) {
 556                 struct lttng_kernel_abi_old_tracer_version old_v;
 557
 558                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_OLD_TRACER_VERSION, &old_v);
 559                 if (ret) {
 560                         goto end;
 561                 }
 562                 v->major = old_v.major;
 563                 v->minor = old_v.minor;
 564                 v->patchlevel = old_v.patchlevel;
 565         } else {
 566                 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_TRACER_VERSION, v);
 567         }
 568
 569 end:
 570         return ret;
 571 }
 572
 573 int kernctl_tracer_abi_version(int fd, struct lttng_kernel_abi_tracer_abi_version *v)
 574 {
 575         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_TRACER_ABI_VERSION, v);
 576 }
 577
 578 int kernctl_wait_quiescent(int fd)
 579 {
 580         return compat_ioctl_no_arg(
 581                 fd, LTTNG_KERNEL_ABI_OLD_WAIT_QUIESCENT, LTTNG_KERNEL_ABI_WAIT_QUIESCENT);
 582 }
 583
 584 int kernctl_buffer_flush(int fd)
 585 {
 586         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH);
 587 }
 588
 589 int kernctl_buffer_flush_empty(int fd)
 590 {
 591         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH_EMPTY);
 592 }
 593
 594 int kernctl_buffer_clear(int fd)
 595 {
 596         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_CLEAR);
 597 }
 598
 599 int kernctl_get_next_subbuf_metadata_check(int fd, bool *consistent)
 600 {
 601         return LTTNG_IOCTL_NO_CHECK(
 602                 fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK, consistent);
 603 }
 604
 605 /* returns the version of the metadata. */
 606 int kernctl_get_metadata_version(int fd, uint64_t *version)
 607 {
 608         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_METADATA_VERSION, version);
 609 }
 610
 611 int kernctl_metadata_cache_dump(int fd)
 612 {
 613         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_METADATA_CACHE_DUMP);
 614 }
 615
 616 /* Buffer operations */
 617
 618 /* For mmap mode, readable without "get" operation */
 619
 620 /* returns the length to mmap. */
 621 int kernctl_get_mmap_len(int fd, unsigned long *len)
 622 {
 623         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_LEN, len);
 624 }
 625
 626 /* returns the maximum size for sub-buffers. */
 627 int kernctl_get_max_subbuf_size(int fd, unsigned long *len)
 628 {
 629         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MAX_SUBBUF_SIZE, len);
 630 }
 631
 632 /*
 633  * For mmap mode, operate on the current packet (between get/put or
 634  * get_next/put_next).
 635  */
 636
 637 /* returns the offset of the subbuffer belonging to the mmap reader. */
 638 int kernctl_get_mmap_read_offset(int fd, unsigned long *off)
 639 {
 640         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_READ_OFFSET, off);
 641 }
 642
 643 /* returns the size of the current sub-buffer, without padding (for mmap). */
 644 int kernctl_get_subbuf_size(int fd, unsigned long *len)
 645 {
 646         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF_SIZE, len);
 647 }
 648
 649 /* returns the size of the current sub-buffer, without padding (for mmap). */
 650 int kernctl_get_padded_subbuf_size(int fd, unsigned long *len)
 651 {
 652         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_PADDED_SUBBUF_SIZE, len);
 653 }
 654
 655 /* Get exclusive read access to the next sub-buffer that can be read. */
 656 int kernctl_get_next_subbuf(int fd)
 657 {
 658         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF);
 659 }
 660
 661 /* Release exclusive sub-buffer access, move consumer forward. */
 662 int kernctl_put_next_subbuf(int fd)
 663 {
 664         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_PUT_NEXT_SUBBUF);
 665 }
 666
 667 /* snapshot */
 668
 669 /* Get a snapshot of the current ring buffer producer and consumer positions */
 670 int kernctl_snapshot(int fd)
 671 {
 672         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT);
 673 }
 674
 675 /*
 676  * Get a snapshot of the current ring buffer producer and consumer positions,
 677  * regardless of whether or not the two positions are contained within the
 678  * same sub-buffer.
 679  */
 680 int kernctl_snapshot_sample_positions(int fd)
 681 {
 682         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS);
 683 }
 684
 685 /* Get the consumer position (iteration start) */
 686 int kernctl_snapshot_get_consumed(int fd, unsigned long *pos)
 687 {
 688         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_CONSUMED, pos);
 689 }
 690
 691 /* Get the producer position (iteration end) */
 692 int kernctl_snapshot_get_produced(int fd, unsigned long *pos)
 693 {
 694         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_PRODUCED, pos);
 695 }
 696
 697 /* Get exclusive read access to the specified sub-buffer position */
 698 int kernctl_get_subbuf(int fd, unsigned long *len)
 699 {
 700         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF, len);
 701 }
 702
 703 /* Release exclusive sub-buffer access */
 704 int kernctl_put_subbuf(int fd)
 705 {
 706         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_PUT_SUBBUF);
 707 }
 708
 709 /* Returns the timestamp begin of the current sub-buffer. */
 710 int kernctl_get_timestamp_begin(int fd, uint64_t *timestamp_begin)
 711 {
 712         return LTTNG_IOCTL_CHECK(
 713                 fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_BEGIN, timestamp_begin);
 714 }
 715
 716 /* Returns the timestamp end of the current sub-buffer. */
 717 int kernctl_get_timestamp_end(int fd, uint64_t *timestamp_end)
 718 {
 719         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_END, timestamp_end);
 720 }
 721
 722 /* Returns the number of discarded events in the current sub-buffer. */
 723 int kernctl_get_events_discarded(int fd, uint64_t *events_discarded)
 724 {
 725         return LTTNG_IOCTL_CHECK(
 726                 fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_EVENTS_DISCARDED, events_discarded);
 727 }
 728
 729 /* Returns the content size in the current sub-buffer. */
 730 int kernctl_get_content_size(int fd, uint64_t *content_size)
 731 {
 732         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_CONTENT_SIZE, content_size);
 733 }
 734
 735 /* Returns the packet size in the current sub-buffer. */
 736 int kernctl_get_packet_size(int fd, uint64_t *packet_size)
 737 {
 738         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_PACKET_SIZE, packet_size);
 739 }
 740
 741 /* Returns the stream id of the current sub-buffer. */
 742 int kernctl_get_stream_id(int fd, uint64_t *stream_id)
 743 {
 744         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_STREAM_ID, stream_id);
 745 }
 746
 747 /* Returns the current timestamp. */
 748 int kernctl_get_current_timestamp(int fd, uint64_t *ts)
 749 {
 750         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_CURRENT_TIMESTAMP, ts);
 751 }
 752
 753 /* Returns the packet sequence number of the current sub-buffer. */
 754 int kernctl_get_sequence_number(int fd, uint64_t *seq)
 755 {
 756         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SEQ_NUM, seq);
 757 }
 758
 759 /* Returns the stream instance id. */
 760 int kernctl_get_instance_id(int fd, uint64_t *id)
 761 {
 762         return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ABI_RING_BUFFER_INSTANCE_ID, id);
 763 }