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>
6 * SPDX-License-Identifier: GPL-2.0-only
10 #include "lttng/tracker.h"
12 #define __USE_LINUX_IOCTL_DEFS
13 #include <sys/ioctl.h>
15 #include <common/align.hpp>
16 #include <common/macros.hpp>
17 #include <common/compat/errno.hpp>
19 #include <common/time.hpp>
21 #include "kernel-ctl.hpp"
22 #include "kernel-ioctl.hpp"
24 #define LTTNG_IOCTL_CHECK(fildes, request, ...) \
26 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
27 LTTNG_ASSERT(_ioctl_ret <= 0); \
28 !_ioctl_ret ? 0 : -errno; \
31 #define LTTNG_IOCTL_NO_CHECK(fildes, request, ...) \
33 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
34 _ioctl_ret >= 0 ? _ioctl_ret : -errno; \
38 * This flag indicates which version of the kernel ABI to use. The old
39 * ABI (namespace _old) does not support a 32-bit user-space when the
40 * kernel is 64-bit. The old ABI is kept here for compatibility but is
41 * deprecated and will be removed eventually.
43 static int lttng_kernel_abi_use_old_abi
= -1;
46 * Execute the new or old ioctl depending on the ABI version.
47 * If the ABI version is not determined yet (lttng_kernel_abi_use_old_abi = -1),
48 * this function tests if the new ABI is available and otherwise fallbacks
50 * This function takes the fd on which the ioctl must be executed and the old
51 * and new request codes.
52 * It returns the return value of the ioctl executed.
54 static inline int compat_ioctl_no_arg(int fd
, unsigned long oldname
,
55 unsigned long newname
)
59 if (lttng_kernel_abi_use_old_abi
== -1) {
60 ret
= LTTNG_IOCTL_NO_CHECK(fd
, newname
);
62 lttng_kernel_abi_use_old_abi
= 0;
65 lttng_kernel_abi_use_old_abi
= 1;
67 if (lttng_kernel_abi_use_old_abi
) {
68 ret
= LTTNG_IOCTL_NO_CHECK(fd
, oldname
);
70 ret
= LTTNG_IOCTL_NO_CHECK(fd
, newname
);
77 int kernctl_create_session(int fd
)
79 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_SESSION
,
80 LTTNG_KERNEL_ABI_SESSION
);
83 /* open the metadata global channel */
84 int kernctl_open_metadata(int fd
, struct lttng_channel_attr
*chops
)
86 struct lttng_kernel_abi_channel channel
;
88 if (lttng_kernel_abi_use_old_abi
) {
89 struct lttng_kernel_abi_old_channel old_channel
;
91 memset(&old_channel
, 0, sizeof(old_channel
));
92 old_channel
.overwrite
= chops
->overwrite
;
93 old_channel
.subbuf_size
= chops
->subbuf_size
;
94 old_channel
.num_subbuf
= chops
->num_subbuf
;
95 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
96 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
97 old_channel
.output
= chops
->output
;
99 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
101 * The new channel padding is smaller than the old ABI so we use the
102 * new ABI padding size for the memcpy.
104 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
106 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_METADATA
,
110 memset(&channel
, 0, sizeof(channel
));
111 channel
.overwrite
= chops
->overwrite
;
112 channel
.subbuf_size
= chops
->subbuf_size
;
113 channel
.num_subbuf
= chops
->num_subbuf
;
114 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
115 channel
.read_timer_interval
= chops
->read_timer_interval
;
116 channel
.output
= chops
->output
;
117 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
119 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_METADATA
, &channel
);
122 int kernctl_create_channel(int fd
, struct lttng_channel_attr
*chops
)
124 struct lttng_kernel_abi_channel channel
;
126 memset(&channel
, 0, sizeof(channel
));
127 if (lttng_kernel_abi_use_old_abi
) {
128 struct lttng_kernel_abi_old_channel old_channel
;
130 old_channel
.overwrite
= chops
->overwrite
;
131 old_channel
.subbuf_size
= chops
->subbuf_size
;
132 old_channel
.num_subbuf
= chops
->num_subbuf
;
133 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
134 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
135 old_channel
.output
= chops
->output
;
137 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
139 * The new channel padding is smaller than the old ABI so we use the
140 * new ABI padding size for the memcpy.
142 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
144 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_CHANNEL
,
148 channel
.overwrite
= chops
->overwrite
;
149 channel
.subbuf_size
= chops
->subbuf_size
;
150 channel
.num_subbuf
= chops
->num_subbuf
;
151 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
152 channel
.read_timer_interval
= chops
->read_timer_interval
;
153 channel
.output
= chops
->output
;
154 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
156 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_CHANNEL
, &channel
);
159 int kernctl_syscall_mask(int fd
, char **syscall_mask
, uint32_t *nr_bits
)
161 struct lttng_kernel_abi_syscall_mask kmask_len
, *kmask
= NULL
;
162 size_t array_alloc_len
;
177 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SYSCALL_MASK
, &kmask_len
);
182 array_alloc_len
= lttng_align_ceil(kmask_len
.len
, 8) >> 3;
184 kmask
= zmalloc
<lttng_kernel_abi_syscall_mask
>(sizeof(*kmask
) + array_alloc_len
);
190 kmask
->len
= kmask_len
.len
;
191 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SYSCALL_MASK
, kmask
);
196 new_mask
= (char *) realloc(*syscall_mask
, array_alloc_len
);
201 memcpy(new_mask
, kmask
->mask
, array_alloc_len
);
202 *syscall_mask
= new_mask
;
203 *nr_bits
= kmask
->len
;
210 int kernctl_track_pid(int fd
, int pid
)
212 int ret
= LTTNG_IOCTL_CHECK(
213 fd
, LTTNG_KERNEL_ABI_SESSION_TRACK_PID
, pid
);
215 if (ret
== -ENOSYS
) {
216 ret
= LTTNG_IOCTL_CHECK(fd
,
217 LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_PID
, pid
);
223 int kernctl_untrack_pid(int fd
, int pid
)
225 int ret
= LTTNG_IOCTL_CHECK(
226 fd
, LTTNG_KERNEL_ABI_SESSION_UNTRACK_PID
, pid
);
228 if (ret
== -ENOSYS
) {
229 ret
= LTTNG_IOCTL_CHECK(fd
,
230 LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_PID
, pid
);
236 int kernctl_list_tracker_pids(int fd
)
238 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_PIDS
);
241 static enum lttng_kernel_abi_tracker_type
get_kernel_tracker_type(
242 enum lttng_process_attr process_attr
)
244 switch (process_attr
) {
245 case LTTNG_PROCESS_ATTR_PROCESS_ID
:
246 return LTTNG_KERNEL_ABI_TRACKER_PID
;
247 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
248 return LTTNG_KERNEL_ABI_TRACKER_VPID
;
249 case LTTNG_PROCESS_ATTR_USER_ID
:
250 return LTTNG_KERNEL_ABI_TRACKER_UID
;
251 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
252 return LTTNG_KERNEL_ABI_TRACKER_VUID
;
253 case LTTNG_PROCESS_ATTR_GROUP_ID
:
254 return LTTNG_KERNEL_ABI_TRACKER_GID
;
255 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
256 return LTTNG_KERNEL_ABI_TRACKER_VGID
;
258 return LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
;
262 int kernctl_track_id(int fd
, enum lttng_process_attr process_attr
, int id
)
264 struct lttng_kernel_abi_tracker_args args
;
268 args
.type
= get_kernel_tracker_type(process_attr
);
269 if (args
.type
== LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
) {
274 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_TRACK_ID
, &args
);
275 if (ret
== -ENOSYS
) {
276 ret
= LTTNG_IOCTL_CHECK(fd
,
277 LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_ID
, &args
);
283 int kernctl_untrack_id(int fd
, enum lttng_process_attr process_attr
, int id
)
285 struct lttng_kernel_abi_tracker_args args
;
289 args
.type
= get_kernel_tracker_type(process_attr
);
290 if (args
.type
== LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
) {
295 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_UNTRACK_ID
, &args
);
296 if (ret
== -ENOSYS
) {
297 ret
= LTTNG_IOCTL_CHECK(fd
,
298 LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_ID
, &args
);
304 int kernctl_list_tracker_ids(int fd
, enum lttng_process_attr process_attr
)
306 struct lttng_kernel_abi_tracker_args args
;
310 args
.type
= get_kernel_tracker_type(process_attr
);
311 if (args
.type
== LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
) {
316 ret
= LTTNG_IOCTL_NO_CHECK(
317 fd
, LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_IDS
, &args
);
318 if (ret
== -ENOSYS
) {
319 ret
= LTTNG_IOCTL_NO_CHECK(fd
,
320 LTTNG_KERNEL_ABI_OLD_SESSION_LIST_TRACKER_IDS
,
327 int kernctl_session_regenerate_metadata(int fd
)
329 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_METADATA_REGEN
);
332 int kernctl_session_regenerate_statedump(int fd
)
334 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_STATEDUMP
);
337 int kernctl_session_set_name(int fd
, const char *name
)
340 struct lttng_kernel_abi_session_name session_name
;
342 ret
= lttng_strncpy(session_name
.name
, name
, sizeof(session_name
.name
));
347 ret
= LTTNG_IOCTL_CHECK(
348 fd
, LTTNG_KERNEL_ABI_SESSION_SET_NAME
, &session_name
);
349 if (ret
== -ENOSYS
) {
350 ret
= LTTNG_IOCTL_CHECK(fd
,
351 LTTNG_KERNEL_ABI_OLD_SESSION_SET_NAME
,
359 int kernctl_session_set_creation_time(int fd
, time_t time
)
362 struct lttng_kernel_abi_session_creation_time creation_time
;
364 ret
= time_to_iso8601_str(time
, creation_time
.iso8601
,
365 sizeof(creation_time
.iso8601
));
370 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_SET_CREATION_TIME
,
372 if (ret
== -ENOSYS
) {
373 ret
= LTTNG_IOCTL_CHECK(fd
,
374 LTTNG_KERNEL_ABI_OLD_SESSION_SET_CREATION_TIME
,
382 int kernctl_session_set_trace_format(int fd
, const lttng::trace_format_descriptor
& trace_format
)
385 struct lttng_kernel_abi_session_trace_format k_trace_format
;
387 switch (trace_format
.type()) {
388 case LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_1
:
389 k_trace_format
.type
= (uint32_t) LTTNG_KERNEL_ABI_TRACE_FORMAT_CTF1
;
391 case LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_2
:
392 k_trace_format
.type
= (uint32_t) LTTNG_KERNEL_ABI_TRACE_FORMAT_CTF2
;
394 case LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_UNKNOWN
:
401 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_SET_TRACE_FORMAT
, &k_trace_format
);
402 if (ret
== -ENOSYS
) {
403 if (trace_format
.type() != LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_1
) {
404 /* Must never happen based on earlier error check */
407 /* Old modules default to ctf1 format. */
415 int kernctl_create_stream(int fd
)
417 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_STREAM
,
418 LTTNG_KERNEL_ABI_STREAM
);
421 int kernctl_create_event(int fd
, struct lttng_kernel_abi_event
*ev
)
423 if (lttng_kernel_abi_use_old_abi
) {
424 struct lttng_kernel_abi_old_event old_event
;
426 memset(&old_event
, 0, sizeof(old_event
));
427 memcpy(old_event
.name
, ev
->name
, sizeof(old_event
.name
));
428 old_event
.instrumentation
= ev
->instrumentation
;
429 switch (ev
->instrumentation
) {
430 case LTTNG_KERNEL_ABI_KPROBE
:
431 old_event
.u
.kprobe
.addr
= ev
->u
.kprobe
.addr
;
432 old_event
.u
.kprobe
.offset
= ev
->u
.kprobe
.offset
;
433 memcpy(old_event
.u
.kprobe
.symbol_name
,
434 ev
->u
.kprobe
.symbol_name
,
435 sizeof(old_event
.u
.kprobe
.symbol_name
));
437 case LTTNG_KERNEL_ABI_KRETPROBE
:
438 old_event
.u
.kretprobe
.addr
= ev
->u
.kretprobe
.addr
;
439 old_event
.u
.kretprobe
.offset
= ev
->u
.kretprobe
.offset
;
440 memcpy(old_event
.u
.kretprobe
.symbol_name
,
441 ev
->u
.kretprobe
.symbol_name
,
442 sizeof(old_event
.u
.kretprobe
.symbol_name
));
444 case LTTNG_KERNEL_ABI_FUNCTION
:
445 memcpy(old_event
.u
.ftrace
.symbol_name
,
446 ev
->u
.ftrace
.symbol_name
,
447 sizeof(old_event
.u
.ftrace
.symbol_name
));
453 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_EVENT
,
456 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_EVENT
, ev
);
459 int kernctl_add_context(int fd
, struct lttng_kernel_abi_context
*ctx
)
461 if (lttng_kernel_abi_use_old_abi
) {
462 struct lttng_kernel_abi_old_context old_ctx
;
464 memset(&old_ctx
, 0, sizeof(old_ctx
));
465 old_ctx
.ctx
= ctx
->ctx
;
466 /* only type that uses the union */
467 if (ctx
->ctx
== LTTNG_KERNEL_ABI_CONTEXT_PERF_CPU_COUNTER
) {
468 old_ctx
.u
.perf_counter
.type
=
469 ctx
->u
.perf_counter
.type
;
470 old_ctx
.u
.perf_counter
.config
=
471 ctx
->u
.perf_counter
.config
;
472 memcpy(old_ctx
.u
.perf_counter
.name
,
473 ctx
->u
.perf_counter
.name
,
474 sizeof(old_ctx
.u
.perf_counter
.name
));
476 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_CONTEXT
,
479 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_CONTEXT
, ctx
);
483 /* Enable event, channel and session LTTNG_IOCTL_CHECK */
484 int kernctl_enable(int fd
)
486 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_ENABLE
,
487 LTTNG_KERNEL_ABI_ENABLE
);
490 /* Disable event, channel and session LTTNG_IOCTL_CHECK */
491 int kernctl_disable(int fd
)
493 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_DISABLE
,
494 LTTNG_KERNEL_ABI_DISABLE
);
497 int kernctl_start_session(int fd
)
499 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_SESSION_START
,
500 LTTNG_KERNEL_ABI_SESSION_START
);
503 int kernctl_stop_session(int fd
)
505 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_SESSION_STOP
,
506 LTTNG_KERNEL_ABI_SESSION_STOP
);
509 int kernctl_create_event_notifier_group(int fd
)
511 return LTTNG_IOCTL_NO_CHECK(fd
,
512 LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_CREATE
);
515 int kernctl_create_event_notifier_group_notification_fd(int group_fd
)
517 return LTTNG_IOCTL_NO_CHECK(group_fd
,
518 LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD
);
521 int kernctl_create_event_notifier_group_error_counter(int group_fd
,
522 const struct lttng_kernel_abi_counter_conf
*error_counter_conf
)
524 return LTTNG_IOCTL_NO_CHECK(group_fd
, LTTNG_KERNEL_ABI_COUNTER
,
528 int kernctl_counter_get_aggregate_value(int counter_fd
,
529 struct lttng_kernel_abi_counter_aggregate
*value
)
531 return LTTNG_IOCTL_NO_CHECK(counter_fd
, LTTNG_KERNEL_ABI_COUNTER_AGGREGATE
,
535 int kernctl_counter_clear(int counter_fd
,
536 struct lttng_kernel_abi_counter_clear
*clear
)
538 return LTTNG_IOCTL_NO_CHECK(counter_fd
, LTTNG_KERNEL_ABI_COUNTER_CLEAR
,
542 int kernctl_create_event_notifier(int group_fd
,
543 const struct lttng_kernel_abi_event_notifier
*event_notifier
)
545 return LTTNG_IOCTL_NO_CHECK(group_fd
,
546 LTTNG_KERNEL_ABI_EVENT_NOTIFIER_CREATE
, event_notifier
);
549 int kernctl_capture(int fd
, const struct lttng_bytecode
*capture
)
552 struct lttng_kernel_abi_capture_bytecode
*kb
;
554 /* Translate bytecode to kernel bytecode. */
555 kb
= zmalloc
<lttng_kernel_abi_capture_bytecode
>(sizeof(*kb
) + capture
->len
);
561 kb
->len
= capture
->len
;
562 kb
->reloc_offset
= capture
->reloc_table_offset
;
563 kb
->seqnum
= capture
->seqnum
;
564 memcpy(kb
->data
, capture
->data
, capture
->len
);
565 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_CAPTURE
, kb
);
571 int kernctl_filter(int fd
, const struct lttng_bytecode
*filter
)
573 struct lttng_kernel_abi_filter_bytecode
*kb
;
577 /* Translate bytecode to kernel bytecode */
578 kb
= zmalloc
<lttng_kernel_abi_filter_bytecode
>(sizeof(*kb
) + filter
->len
);
581 kb
->len
= len
= filter
->len
;
582 kb
->reloc_offset
= filter
->reloc_table_offset
;
583 kb
->seqnum
= filter
->seqnum
;
584 memcpy(kb
->data
, filter
->data
, len
);
585 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_FILTER
, kb
);
590 int kernctl_add_callsite(int fd
, struct lttng_kernel_abi_event_callsite
*callsite
)
592 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_ADD_CALLSITE
, callsite
);
595 int kernctl_tracepoint_list(int fd
)
597 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_TRACEPOINT_LIST
,
598 LTTNG_KERNEL_ABI_TRACEPOINT_LIST
);
601 int kernctl_syscall_list(int fd
)
603 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_SYSCALL_LIST
);
606 int kernctl_tracer_version(int fd
, struct lttng_kernel_abi_tracer_version
*v
)
610 if (lttng_kernel_abi_use_old_abi
== -1) {
611 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_TRACER_VERSION
, v
);
613 lttng_kernel_abi_use_old_abi
= 0;
616 lttng_kernel_abi_use_old_abi
= 1;
618 if (lttng_kernel_abi_use_old_abi
) {
619 struct lttng_kernel_abi_old_tracer_version old_v
;
621 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_TRACER_VERSION
, &old_v
);
625 v
->major
= old_v
.major
;
626 v
->minor
= old_v
.minor
;
627 v
->patchlevel
= old_v
.patchlevel
;
629 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_TRACER_VERSION
, v
);
636 int kernctl_tracer_abi_version(int fd
,
637 struct lttng_kernel_abi_tracer_abi_version
*v
)
639 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_TRACER_ABI_VERSION
, v
);
642 int kernctl_wait_quiescent(int fd
)
644 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_WAIT_QUIESCENT
,
645 LTTNG_KERNEL_ABI_WAIT_QUIESCENT
);
648 int kernctl_buffer_flush(int fd
)
650 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH
);
653 int kernctl_buffer_flush_empty(int fd
)
655 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH_EMPTY
);
658 int kernctl_buffer_clear(int fd
)
660 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_CLEAR
);
663 int kernctl_get_next_subbuf_metadata_check(int fd
, bool *consistent
)
665 return LTTNG_IOCTL_NO_CHECK(fd
,
666 LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK
,
670 /* returns the version of the metadata. */
671 int kernctl_get_metadata_version(int fd
, uint64_t *version
)
673 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_METADATA_VERSION
,
677 int kernctl_metadata_cache_dump(int fd
)
679 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_METADATA_CACHE_DUMP
);
682 /* Buffer operations */
684 /* For mmap mode, readable without "get" operation */
686 /* returns the length to mmap. */
687 int kernctl_get_mmap_len(int fd
, unsigned long *len
)
689 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_LEN
,
693 /* returns the maximum size for sub-buffers. */
694 int kernctl_get_max_subbuf_size(int fd
, unsigned long *len
)
696 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MAX_SUBBUF_SIZE
,
701 * For mmap mode, operate on the current packet (between get/put or
702 * get_next/put_next).
705 /* returns the offset of the subbuffer belonging to the mmap reader. */
706 int kernctl_get_mmap_read_offset(int fd
, unsigned long *off
)
708 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_READ_OFFSET
,
712 /* returns the size of the current sub-buffer, without padding (for mmap). */
713 int kernctl_get_subbuf_size(int fd
, unsigned long *len
)
715 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF_SIZE
,
719 /* returns the size of the current sub-buffer, without padding (for mmap). */
720 int kernctl_get_padded_subbuf_size(int fd
, unsigned long *len
)
722 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_PADDED_SUBBUF_SIZE
,
726 /* Get exclusive read access to the next sub-buffer that can be read. */
727 int kernctl_get_next_subbuf(int fd
)
729 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF
);
733 /* Release exclusive sub-buffer access, move consumer forward. */
734 int kernctl_put_next_subbuf(int fd
)
736 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_PUT_NEXT_SUBBUF
);
741 /* Get a snapshot of the current ring buffer producer and consumer positions */
742 int kernctl_snapshot(int fd
)
744 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT
);
748 * Get a snapshot of the current ring buffer producer and consumer positions,
749 * regardless of whether or not the two positions are contained within the
752 int kernctl_snapshot_sample_positions(int fd
)
754 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS
);
757 /* Get the consumer position (iteration start) */
758 int kernctl_snapshot_get_consumed(int fd
, unsigned long *pos
)
760 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_CONSUMED
,
764 /* Get the producer position (iteration end) */
765 int kernctl_snapshot_get_produced(int fd
, unsigned long *pos
)
767 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_PRODUCED
,
771 /* Get exclusive read access to the specified sub-buffer position */
772 int kernctl_get_subbuf(int fd
, unsigned long *len
)
774 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF
,
778 /* Release exclusive sub-buffer access */
779 int kernctl_put_subbuf(int fd
)
781 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_PUT_SUBBUF
);
784 /* Returns the timestamp begin of the current sub-buffer. */
785 int kernctl_get_timestamp_begin(int fd
, uint64_t *timestamp_begin
)
787 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_BEGIN
,
791 /* Returns the timestamp end of the current sub-buffer. */
792 int kernctl_get_timestamp_end(int fd
, uint64_t *timestamp_end
)
794 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_END
,
798 /* Returns the number of discarded events in the current sub-buffer. */
799 int kernctl_get_events_discarded(int fd
, uint64_t *events_discarded
)
801 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_EVENTS_DISCARDED
,
805 /* Returns the content size in the current sub-buffer. */
806 int kernctl_get_content_size(int fd
, uint64_t *content_size
)
808 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_CONTENT_SIZE
,
812 /* Returns the packet size in the current sub-buffer. */
813 int kernctl_get_packet_size(int fd
, uint64_t *packet_size
)
815 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_PACKET_SIZE
,
819 /* Returns the stream id of the current sub-buffer. */
820 int kernctl_get_stream_id(int fd
, uint64_t *stream_id
)
822 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_STREAM_ID
,
826 /* Returns the current timestamp. */
827 int kernctl_get_current_timestamp(int fd
, uint64_t *ts
)
829 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_CURRENT_TIMESTAMP
,
833 /* Returns the packet sequence number of the current sub-buffer. */
834 int kernctl_get_sequence_number(int fd
, uint64_t *seq
)
836 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SEQ_NUM
,
840 /* Returns the stream instance id. */
841 int kernctl_get_instance_id(int fd
, uint64_t *id
)
843 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_INSTANCE_ID
,