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>
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.h>
16 #include <common/macros.h>
17 #include <common/compat/errno.h>
20 #include <common/time.h>
22 #include "kernel-ctl.h"
23 #include "kernel-ioctl.h"
25 #define LTTNG_IOCTL_CHECK(fildes, request, ...) \
27 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
28 assert(_ioctl_ret <= 0); \
29 !_ioctl_ret ? 0 : -errno; \
32 #define LTTNG_IOCTL_NO_CHECK(fildes, request, ...) \
34 int _ioctl_ret = ioctl(fildes, request, ##__VA_ARGS__); \
35 _ioctl_ret >= 0 ? _ioctl_ret : -errno; \
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.
44 static int lttng_kernel_abi_use_old_abi
= -1;
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
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.
55 static inline int compat_ioctl_no_arg(int fd
, unsigned long oldname
,
56 unsigned long newname
)
60 if (lttng_kernel_abi_use_old_abi
== -1) {
61 ret
= LTTNG_IOCTL_NO_CHECK(fd
, newname
);
63 lttng_kernel_abi_use_old_abi
= 0;
66 lttng_kernel_abi_use_old_abi
= 1;
68 if (lttng_kernel_abi_use_old_abi
) {
69 ret
= LTTNG_IOCTL_NO_CHECK(fd
, oldname
);
71 ret
= LTTNG_IOCTL_NO_CHECK(fd
, newname
);
78 int kernctl_create_session(int fd
)
80 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_SESSION
,
81 LTTNG_KERNEL_ABI_SESSION
);
84 /* open the metadata global channel */
85 int kernctl_open_metadata(int fd
, struct lttng_channel_attr
*chops
)
87 struct lttng_kernel_abi_channel channel
;
89 if (lttng_kernel_abi_use_old_abi
) {
90 struct lttng_kernel_abi_old_channel old_channel
;
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
;
100 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
102 * The new channel padding is smaller than the old ABI so we use the
103 * new ABI padding size for the memcpy.
105 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
107 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_METADATA
,
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
));
120 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_METADATA
, &channel
);
123 int kernctl_create_channel(int fd
, struct lttng_channel_attr
*chops
)
125 struct lttng_kernel_abi_channel channel
;
127 memset(&channel
, 0, sizeof(channel
));
128 if (lttng_kernel_abi_use_old_abi
) {
129 struct lttng_kernel_abi_old_channel old_channel
;
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
;
138 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
140 * The new channel padding is smaller than the old ABI so we use the
141 * new ABI padding size for the memcpy.
143 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
145 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_CHANNEL
,
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
));
157 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_CHANNEL
, &channel
);
160 int kernctl_syscall_mask(int fd
, char **syscall_mask
, uint32_t *nr_bits
)
162 struct lttng_kernel_abi_syscall_mask kmask_len
, *kmask
= NULL
;
163 size_t array_alloc_len
;
178 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SYSCALL_MASK
, &kmask_len
);
183 array_alloc_len
= ALIGN(kmask_len
.len
, 8) >> 3;
185 kmask
= zmalloc(sizeof(*kmask
) + array_alloc_len
);
191 kmask
->len
= kmask_len
.len
;
192 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SYSCALL_MASK
, kmask
);
197 new_mask
= realloc(*syscall_mask
, array_alloc_len
);
202 memcpy(new_mask
, kmask
->mask
, array_alloc_len
);
203 *syscall_mask
= new_mask
;
204 *nr_bits
= kmask
->len
;
211 int kernctl_track_pid(int fd
, int pid
)
213 int ret
= LTTNG_IOCTL_CHECK(
214 fd
, LTTNG_KERNEL_ABI_SESSION_TRACK_PID
, pid
);
216 if (ret
== -ENOSYS
) {
217 ret
= LTTNG_IOCTL_CHECK(fd
,
218 LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_PID
, pid
);
224 int kernctl_untrack_pid(int fd
, int pid
)
226 int ret
= LTTNG_IOCTL_CHECK(
227 fd
, LTTNG_KERNEL_ABI_SESSION_UNTRACK_PID
, pid
);
229 if (ret
== -ENOSYS
) {
230 ret
= LTTNG_IOCTL_CHECK(fd
,
231 LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_PID
, pid
);
237 int kernctl_list_tracker_pids(int fd
)
239 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_PIDS
);
242 static enum lttng_kernel_abi_tracker_type
get_kernel_tracker_type(
243 enum lttng_process_attr process_attr
)
245 switch (process_attr
) {
246 case LTTNG_PROCESS_ATTR_PROCESS_ID
:
247 return LTTNG_KERNEL_ABI_TRACKER_PID
;
248 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
249 return LTTNG_KERNEL_ABI_TRACKER_VPID
;
250 case LTTNG_PROCESS_ATTR_USER_ID
:
251 return LTTNG_KERNEL_ABI_TRACKER_UID
;
252 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
253 return LTTNG_KERNEL_ABI_TRACKER_VUID
;
254 case LTTNG_PROCESS_ATTR_GROUP_ID
:
255 return LTTNG_KERNEL_ABI_TRACKER_GID
;
256 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
257 return LTTNG_KERNEL_ABI_TRACKER_VGID
;
259 return LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
;
263 int kernctl_track_id(int fd
, enum lttng_process_attr process_attr
, int id
)
265 struct lttng_kernel_abi_tracker_args args
;
269 args
.type
= get_kernel_tracker_type(process_attr
);
270 if (args
.type
== LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
) {
275 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_TRACK_ID
, &args
);
276 if (ret
== -ENOSYS
) {
277 ret
= LTTNG_IOCTL_CHECK(fd
,
278 LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_ID
, &args
);
284 int kernctl_untrack_id(int fd
, enum lttng_process_attr process_attr
, int id
)
286 struct lttng_kernel_abi_tracker_args args
;
290 args
.type
= get_kernel_tracker_type(process_attr
);
291 if (args
.type
== LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
) {
296 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_UNTRACK_ID
, &args
);
297 if (ret
== -ENOSYS
) {
298 ret
= LTTNG_IOCTL_CHECK(fd
,
299 LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_ID
, &args
);
305 int kernctl_list_tracker_ids(int fd
, enum lttng_process_attr process_attr
)
307 struct lttng_kernel_abi_tracker_args args
;
311 args
.type
= get_kernel_tracker_type(process_attr
);
312 if (args
.type
== LTTNG_KERNEL_ABI_TRACKER_UNKNOWN
) {
317 ret
= LTTNG_IOCTL_NO_CHECK(
318 fd
, LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_IDS
, &args
);
319 if (ret
== -ENOSYS
) {
320 ret
= LTTNG_IOCTL_NO_CHECK(fd
,
321 LTTNG_KERNEL_ABI_OLD_SESSION_LIST_TRACKER_IDS
,
328 int kernctl_session_regenerate_metadata(int fd
)
330 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_METADATA_REGEN
);
333 int kernctl_session_regenerate_statedump(int fd
)
335 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_STATEDUMP
);
338 int kernctl_session_set_name(int fd
, const char *name
)
341 struct lttng_kernel_abi_session_name session_name
;
343 ret
= lttng_strncpy(session_name
.name
, name
, sizeof(session_name
.name
));
348 ret
= LTTNG_IOCTL_CHECK(
349 fd
, LTTNG_KERNEL_ABI_SESSION_SET_NAME
, &session_name
);
350 if (ret
== -ENOSYS
) {
351 ret
= LTTNG_IOCTL_CHECK(fd
,
352 LTTNG_KERNEL_ABI_OLD_SESSION_SET_NAME
,
360 int kernctl_session_set_creation_time(int fd
, time_t time
)
363 struct lttng_kernel_abi_session_creation_time creation_time
;
365 ret
= time_to_iso8601_str(time
, creation_time
.iso8601
,
366 sizeof(creation_time
.iso8601
));
371 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_SESSION_SET_CREATION_TIME
,
373 if (ret
== -ENOSYS
) {
374 ret
= LTTNG_IOCTL_CHECK(fd
,
375 LTTNG_KERNEL_ABI_OLD_SESSION_SET_CREATION_TIME
,
383 int kernctl_create_stream(int fd
)
385 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_STREAM
,
386 LTTNG_KERNEL_ABI_STREAM
);
389 int kernctl_create_event(int fd
, struct lttng_kernel_abi_event
*ev
)
391 if (lttng_kernel_abi_use_old_abi
) {
392 struct lttng_kernel_abi_old_event old_event
;
394 memset(&old_event
, 0, sizeof(old_event
));
395 memcpy(old_event
.name
, ev
->name
, sizeof(old_event
.name
));
396 old_event
.instrumentation
= ev
->instrumentation
;
397 switch (ev
->instrumentation
) {
398 case LTTNG_KERNEL_ABI_KPROBE
:
399 old_event
.u
.kprobe
.addr
= ev
->u
.kprobe
.addr
;
400 old_event
.u
.kprobe
.offset
= ev
->u
.kprobe
.offset
;
401 memcpy(old_event
.u
.kprobe
.symbol_name
,
402 ev
->u
.kprobe
.symbol_name
,
403 sizeof(old_event
.u
.kprobe
.symbol_name
));
405 case LTTNG_KERNEL_ABI_KRETPROBE
:
406 old_event
.u
.kretprobe
.addr
= ev
->u
.kretprobe
.addr
;
407 old_event
.u
.kretprobe
.offset
= ev
->u
.kretprobe
.offset
;
408 memcpy(old_event
.u
.kretprobe
.symbol_name
,
409 ev
->u
.kretprobe
.symbol_name
,
410 sizeof(old_event
.u
.kretprobe
.symbol_name
));
412 case LTTNG_KERNEL_ABI_FUNCTION
:
413 memcpy(old_event
.u
.ftrace
.symbol_name
,
414 ev
->u
.ftrace
.symbol_name
,
415 sizeof(old_event
.u
.ftrace
.symbol_name
));
421 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_EVENT
,
424 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_EVENT
, ev
);
427 int kernctl_add_context(int fd
, struct lttng_kernel_abi_context
*ctx
)
429 if (lttng_kernel_abi_use_old_abi
) {
430 struct lttng_kernel_abi_old_context old_ctx
;
432 memset(&old_ctx
, 0, sizeof(old_ctx
));
433 old_ctx
.ctx
= ctx
->ctx
;
434 /* only type that uses the union */
435 if (ctx
->ctx
== LTTNG_KERNEL_ABI_CONTEXT_PERF_CPU_COUNTER
) {
436 old_ctx
.u
.perf_counter
.type
=
437 ctx
->u
.perf_counter
.type
;
438 old_ctx
.u
.perf_counter
.config
=
439 ctx
->u
.perf_counter
.config
;
440 memcpy(old_ctx
.u
.perf_counter
.name
,
441 ctx
->u
.perf_counter
.name
,
442 sizeof(old_ctx
.u
.perf_counter
.name
));
444 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_CONTEXT
,
447 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_CONTEXT
, ctx
);
451 /* Enable event, channel and session LTTNG_IOCTL_CHECK */
452 int kernctl_enable(int fd
)
454 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_ENABLE
,
455 LTTNG_KERNEL_ABI_ENABLE
);
458 /* Disable event, channel and session LTTNG_IOCTL_CHECK */
459 int kernctl_disable(int fd
)
461 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_DISABLE
,
462 LTTNG_KERNEL_ABI_DISABLE
);
465 int kernctl_start_session(int fd
)
467 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_SESSION_START
,
468 LTTNG_KERNEL_ABI_SESSION_START
);
471 int kernctl_stop_session(int fd
)
473 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_SESSION_STOP
,
474 LTTNG_KERNEL_ABI_SESSION_STOP
);
477 int kernctl_create_event_notifier_group(int fd
)
479 return LTTNG_IOCTL_NO_CHECK(fd
,
480 LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_CREATE
);
483 int kernctl_create_event_notifier_group_notification_fd(int group_fd
)
485 return LTTNG_IOCTL_NO_CHECK(group_fd
,
486 LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD
);
489 int kernctl_create_event_notifier_group_error_counter(int group_fd
,
490 const struct lttng_kernel_abi_counter_conf
*error_counter_conf
)
492 return LTTNG_IOCTL_NO_CHECK(group_fd
, LTTNG_KERNEL_ABI_COUNTER
,
496 int kernctl_counter_get_aggregate_value(int counter_fd
,
497 struct lttng_kernel_abi_counter_aggregate
*value
)
499 return LTTNG_IOCTL_NO_CHECK(counter_fd
, LTTNG_KERNEL_ABI_COUNTER_AGGREGATE
,
503 int kernctl_counter_clear(int counter_fd
,
504 struct lttng_kernel_abi_counter_clear
*clear
)
506 return LTTNG_IOCTL_NO_CHECK(counter_fd
, LTTNG_KERNEL_ABI_COUNTER_CLEAR
,
510 int kernctl_create_event_notifier(int group_fd
,
511 const struct lttng_kernel_abi_event_notifier
*event_notifier
)
513 return LTTNG_IOCTL_NO_CHECK(group_fd
,
514 LTTNG_KERNEL_ABI_EVENT_NOTIFIER_CREATE
, event_notifier
);
517 int kernctl_capture(int fd
, const struct lttng_bytecode
*capture
)
520 struct lttng_kernel_abi_capture_bytecode
*kb
;
522 /* Translate bytecode to kernel bytecode. */
523 kb
= zmalloc(sizeof(*kb
) + capture
->len
);
529 kb
->len
= capture
->len
;
530 kb
->reloc_offset
= capture
->reloc_table_offset
;
531 kb
->seqnum
= capture
->seqnum
;
532 memcpy(kb
->data
, capture
->data
, capture
->len
);
533 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_CAPTURE
, kb
);
539 int kernctl_filter(int fd
, const struct lttng_bytecode
*filter
)
541 struct lttng_kernel_abi_filter_bytecode
*kb
;
545 /* Translate bytecode to kernel bytecode */
546 kb
= zmalloc(sizeof(*kb
) + filter
->len
);
549 kb
->len
= len
= filter
->len
;
550 kb
->reloc_offset
= filter
->reloc_table_offset
;
551 kb
->seqnum
= filter
->seqnum
;
552 memcpy(kb
->data
, filter
->data
, len
);
553 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_FILTER
, kb
);
558 int kernctl_add_callsite(int fd
, struct lttng_kernel_abi_event_callsite
*callsite
)
560 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_ADD_CALLSITE
, callsite
);
563 int kernctl_tracepoint_list(int fd
)
565 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_TRACEPOINT_LIST
,
566 LTTNG_KERNEL_ABI_TRACEPOINT_LIST
);
569 int kernctl_syscall_list(int fd
)
571 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_ABI_SYSCALL_LIST
);
574 int kernctl_tracer_version(int fd
, struct lttng_kernel_abi_tracer_version
*v
)
578 if (lttng_kernel_abi_use_old_abi
== -1) {
579 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_TRACER_VERSION
, v
);
581 lttng_kernel_abi_use_old_abi
= 0;
584 lttng_kernel_abi_use_old_abi
= 1;
586 if (lttng_kernel_abi_use_old_abi
) {
587 struct lttng_kernel_abi_old_tracer_version old_v
;
589 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_OLD_TRACER_VERSION
, &old_v
);
593 v
->major
= old_v
.major
;
594 v
->minor
= old_v
.minor
;
595 v
->patchlevel
= old_v
.patchlevel
;
597 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_TRACER_VERSION
, v
);
604 int kernctl_tracer_abi_version(int fd
,
605 struct lttng_kernel_abi_tracer_abi_version
*v
)
607 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_TRACER_ABI_VERSION
, v
);
610 int kernctl_wait_quiescent(int fd
)
612 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_ABI_OLD_WAIT_QUIESCENT
,
613 LTTNG_KERNEL_ABI_WAIT_QUIESCENT
);
616 int kernctl_buffer_flush(int fd
)
618 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH
);
621 int kernctl_buffer_flush_empty(int fd
)
623 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH_EMPTY
);
626 int kernctl_buffer_clear(int fd
)
628 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_CLEAR
);
631 int kernctl_get_next_subbuf_metadata_check(int fd
, bool *consistent
)
633 return LTTNG_IOCTL_NO_CHECK(fd
,
634 LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK
,
638 /* returns the version of the metadata. */
639 int kernctl_get_metadata_version(int fd
, uint64_t *version
)
641 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_METADATA_VERSION
,
645 int kernctl_metadata_cache_dump(int fd
)
647 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_METADATA_CACHE_DUMP
);
650 /* Buffer operations */
652 /* For mmap mode, readable without "get" operation */
654 /* returns the length to mmap. */
655 int kernctl_get_mmap_len(int fd
, unsigned long *len
)
657 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_LEN
,
661 /* returns the maximum size for sub-buffers. */
662 int kernctl_get_max_subbuf_size(int fd
, unsigned long *len
)
664 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MAX_SUBBUF_SIZE
,
669 * For mmap mode, operate on the current packet (between get/put or
670 * get_next/put_next).
673 /* returns the offset of the subbuffer belonging to the mmap reader. */
674 int kernctl_get_mmap_read_offset(int fd
, unsigned long *off
)
676 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_READ_OFFSET
,
680 /* returns the size of the current sub-buffer, without padding (for mmap). */
681 int kernctl_get_subbuf_size(int fd
, unsigned long *len
)
683 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF_SIZE
,
687 /* returns the size of the current sub-buffer, without padding (for mmap). */
688 int kernctl_get_padded_subbuf_size(int fd
, unsigned long *len
)
690 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_PADDED_SUBBUF_SIZE
,
694 /* Get exclusive read access to the next sub-buffer that can be read. */
695 int kernctl_get_next_subbuf(int fd
)
697 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF
);
701 /* Release exclusive sub-buffer access, move consumer forward. */
702 int kernctl_put_next_subbuf(int fd
)
704 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_PUT_NEXT_SUBBUF
);
709 /* Get a snapshot of the current ring buffer producer and consumer positions */
710 int kernctl_snapshot(int fd
)
712 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT
);
716 * Get a snapshot of the current ring buffer producer and consumer positions,
717 * regardless of whether or not the two positions are contained within the
720 int kernctl_snapshot_sample_positions(int fd
)
722 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS
);
725 /* Get the consumer position (iteration start) */
726 int kernctl_snapshot_get_consumed(int fd
, unsigned long *pos
)
728 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_CONSUMED
,
732 /* Get the producer position (iteration end) */
733 int kernctl_snapshot_get_produced(int fd
, unsigned long *pos
)
735 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_PRODUCED
,
739 /* Get exclusive read access to the specified sub-buffer position */
740 int kernctl_get_subbuf(int fd
, unsigned long *len
)
742 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF
,
746 /* Release exclusive sub-buffer access */
747 int kernctl_put_subbuf(int fd
)
749 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_PUT_SUBBUF
);
752 /* Returns the timestamp begin of the current sub-buffer. */
753 int kernctl_get_timestamp_begin(int fd
, uint64_t *timestamp_begin
)
755 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_BEGIN
,
759 /* Returns the timestamp end of the current sub-buffer. */
760 int kernctl_get_timestamp_end(int fd
, uint64_t *timestamp_end
)
762 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_END
,
766 /* Returns the number of discarded events in the current sub-buffer. */
767 int kernctl_get_events_discarded(int fd
, uint64_t *events_discarded
)
769 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_EVENTS_DISCARDED
,
773 /* Returns the content size in the current sub-buffer. */
774 int kernctl_get_content_size(int fd
, uint64_t *content_size
)
776 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_CONTENT_SIZE
,
780 /* Returns the packet size in the current sub-buffer. */
781 int kernctl_get_packet_size(int fd
, uint64_t *packet_size
)
783 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_PACKET_SIZE
,
787 /* Returns the stream id of the current sub-buffer. */
788 int kernctl_get_stream_id(int fd
, uint64_t *stream_id
)
790 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_STREAM_ID
,
794 /* Returns the current timestamp. */
795 int kernctl_get_current_timestamp(int fd
, uint64_t *ts
)
797 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_CURRENT_TIMESTAMP
,
801 /* Returns the packet sequence number of the current sub-buffer. */
802 int kernctl_get_sequence_number(int fd
, uint64_t *seq
)
804 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_GET_SEQ_NUM
,
808 /* Returns the stream instance id. */
809 int kernctl_get_instance_id(int fd
, uint64_t *id
)
811 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ABI_RING_BUFFER_INSTANCE_ID
,