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
11 #define __USE_LINUX_IOCTL_DEFS
12 #include <sys/ioctl.h>
14 #include <common/align.h>
15 #include <common/macros.h>
19 #include <common/time.h>
21 #include "kernel-ctl.h"
22 #include "kernel-ioctl.h"
24 #define LTTNG_IOCTL_CHECK(fildes, request, ...) ({ \
25 int ret = ioctl(fildes, request, ##__VA_ARGS__);\
30 #define LTTNG_IOCTL_NO_CHECK(fildes, request, ...) ({ \
31 int ret = ioctl(fildes, request, ##__VA_ARGS__);\
32 ret >= 0 ? ret : -errno; \
36 * This flag indicates which version of the kernel ABI to use. The old
37 * ABI (namespace _old) does not support a 32-bit user-space when the
38 * kernel is 64-bit. The old ABI is kept here for compatibility but is
39 * deprecated and will be removed eventually.
41 static int lttng_kernel_use_old_abi
= -1;
44 * Execute the new or old ioctl depending on the ABI version.
45 * If the ABI version is not determined yet (lttng_kernel_use_old_abi = -1),
46 * this function tests if the new ABI is available and otherwise fallbacks
48 * This function takes the fd on which the ioctl must be executed and the old
49 * and new request codes.
50 * It returns the return value of the ioctl executed.
52 static inline int compat_ioctl_no_arg(int fd
, unsigned long oldname
,
53 unsigned long newname
)
57 if (lttng_kernel_use_old_abi
== -1) {
58 ret
= LTTNG_IOCTL_NO_CHECK(fd
, newname
);
60 lttng_kernel_use_old_abi
= 0;
63 lttng_kernel_use_old_abi
= 1;
65 if (lttng_kernel_use_old_abi
) {
66 ret
= LTTNG_IOCTL_NO_CHECK(fd
, oldname
);
68 ret
= LTTNG_IOCTL_NO_CHECK(fd
, newname
);
75 int kernctl_create_session(int fd
)
77 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION
,
78 LTTNG_KERNEL_SESSION
);
81 /* open the metadata global channel */
82 int kernctl_open_metadata(int fd
, struct lttng_channel_attr
*chops
)
84 struct lttng_kernel_channel channel
;
86 if (lttng_kernel_use_old_abi
) {
87 struct lttng_kernel_old_channel old_channel
;
89 memset(&old_channel
, 0, sizeof(old_channel
));
90 old_channel
.overwrite
= chops
->overwrite
;
91 old_channel
.subbuf_size
= chops
->subbuf_size
;
92 old_channel
.num_subbuf
= chops
->num_subbuf
;
93 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
94 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
95 old_channel
.output
= chops
->output
;
97 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
99 * The new channel padding is smaller than the old ABI so we use the
100 * new ABI padding size for the memcpy.
102 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
104 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_OLD_METADATA
,
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
));
117 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_METADATA
, &channel
);
120 int kernctl_create_channel(int fd
, struct lttng_channel_attr
*chops
)
122 struct lttng_kernel_channel channel
;
124 memset(&channel
, 0, sizeof(channel
));
125 if (lttng_kernel_use_old_abi
) {
126 struct lttng_kernel_old_channel old_channel
;
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
;
135 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
137 * The new channel padding is smaller than the old ABI so we use the
138 * new ABI padding size for the memcpy.
140 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
142 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_OLD_CHANNEL
,
146 channel
.overwrite
= chops
->overwrite
;
147 channel
.subbuf_size
= chops
->subbuf_size
;
148 channel
.num_subbuf
= chops
->num_subbuf
;
149 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
150 channel
.read_timer_interval
= chops
->read_timer_interval
;
151 channel
.output
= chops
->output
;
152 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
154 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_CHANNEL
, &channel
);
157 int kernctl_syscall_mask(int fd
, char **syscall_mask
, uint32_t *nr_bits
)
159 struct lttng_kernel_syscall_mask kmask_len
, *kmask
= NULL
;
160 size_t array_alloc_len
;
175 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SYSCALL_MASK
, &kmask_len
);
180 array_alloc_len
= ALIGN(kmask_len
.len
, 8) >> 3;
182 kmask
= zmalloc(sizeof(*kmask
) + array_alloc_len
);
188 kmask
->len
= kmask_len
.len
;
189 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SYSCALL_MASK
, kmask
);
194 new_mask
= realloc(*syscall_mask
, array_alloc_len
);
199 memcpy(new_mask
, kmask
->mask
, array_alloc_len
);
200 *syscall_mask
= new_mask
;
201 *nr_bits
= kmask
->len
;
208 int kernctl_track_pid(int fd
, int pid
)
210 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_TRACK_PID
, pid
);
213 int kernctl_untrack_pid(int fd
, int pid
)
215 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_UNTRACK_PID
, pid
);
218 int kernctl_list_tracker_pids(int fd
)
220 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS
);
223 static enum lttng_kernel_tracker_type
get_kernel_tracker_type(
224 enum lttng_tracker_type type
)
227 case LTTNG_TRACKER_PID
:
228 return LTTNG_KERNEL_TRACKER_PID
;
229 case LTTNG_TRACKER_VPID
:
230 return LTTNG_KERNEL_TRACKER_VPID
;
231 case LTTNG_TRACKER_UID
:
232 return LTTNG_KERNEL_TRACKER_UID
;
233 case LTTNG_TRACKER_VUID
:
234 return LTTNG_KERNEL_TRACKER_VUID
;
235 case LTTNG_TRACKER_GID
:
236 return LTTNG_KERNEL_TRACKER_GID
;
237 case LTTNG_TRACKER_VGID
:
238 return LTTNG_KERNEL_TRACKER_VGID
;
240 return LTTNG_KERNEL_TRACKER_UNKNOWN
;
244 int kernctl_track_id(int fd
, enum lttng_tracker_type tracker_type
, int id
)
246 struct lttng_kernel_tracker_args args
;
249 args
.type
= get_kernel_tracker_type(tracker_type
);
250 if (args
.type
== LTTNG_KERNEL_TRACKER_UNKNOWN
) {
254 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_TRACK_ID
, &args
);
257 int kernctl_untrack_id(int fd
, enum lttng_tracker_type tracker_type
, int id
)
259 struct lttng_kernel_tracker_args args
;
262 args
.type
= get_kernel_tracker_type(tracker_type
);
263 if (args
.type
== LTTNG_KERNEL_TRACKER_UNKNOWN
) {
267 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_UNTRACK_ID
, &args
);
270 int kernctl_list_tracker_ids(int fd
, enum lttng_tracker_type tracker_type
)
272 struct lttng_kernel_tracker_args args
;
275 args
.type
= get_kernel_tracker_type(tracker_type
);
276 if (args
.type
== LTTNG_KERNEL_TRACKER_UNKNOWN
) {
280 return LTTNG_IOCTL_NO_CHECK(
281 fd
, LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS
, &args
);
284 int kernctl_session_regenerate_metadata(int fd
)
286 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_METADATA_REGEN
);
289 int kernctl_session_regenerate_statedump(int fd
)
291 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_STATEDUMP
);
294 int kernctl_session_set_name(int fd
, const char *name
)
297 struct lttng_kernel_session_name session_name
;
299 ret
= lttng_strncpy(session_name
.name
, name
, sizeof(session_name
.name
));
304 ret
= LTTNG_IOCTL_CHECK(
305 fd
, LTTNG_KERNEL_SESSION_SET_NAME
, &session_name
);
310 int kernctl_session_set_creation_time(int fd
, time_t time
)
313 struct lttng_kernel_session_creation_time creation_time
;
315 ret
= time_to_iso8601_str(time
, creation_time
.iso8601
,
316 sizeof(creation_time
.iso8601
));
321 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_SESSION_SET_CREATION_TIME
,
327 int kernctl_create_stream(int fd
)
329 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_STREAM
,
330 LTTNG_KERNEL_STREAM
);
333 int kernctl_create_event(int fd
, struct lttng_kernel_event
*ev
)
335 if (lttng_kernel_use_old_abi
) {
336 struct lttng_kernel_old_event old_event
;
338 memset(&old_event
, 0, sizeof(old_event
));
339 memcpy(old_event
.name
, ev
->name
, sizeof(old_event
.name
));
340 old_event
.instrumentation
= ev
->instrumentation
;
341 switch (ev
->instrumentation
) {
342 case LTTNG_KERNEL_KPROBE
:
343 old_event
.u
.kprobe
.addr
= ev
->u
.kprobe
.addr
;
344 old_event
.u
.kprobe
.offset
= ev
->u
.kprobe
.offset
;
345 memcpy(old_event
.u
.kprobe
.symbol_name
,
346 ev
->u
.kprobe
.symbol_name
,
347 sizeof(old_event
.u
.kprobe
.symbol_name
));
349 case LTTNG_KERNEL_KRETPROBE
:
350 old_event
.u
.kretprobe
.addr
= ev
->u
.kretprobe
.addr
;
351 old_event
.u
.kretprobe
.offset
= ev
->u
.kretprobe
.offset
;
352 memcpy(old_event
.u
.kretprobe
.symbol_name
,
353 ev
->u
.kretprobe
.symbol_name
,
354 sizeof(old_event
.u
.kretprobe
.symbol_name
));
356 case LTTNG_KERNEL_FUNCTION
:
357 memcpy(old_event
.u
.ftrace
.symbol_name
,
358 ev
->u
.ftrace
.symbol_name
,
359 sizeof(old_event
.u
.ftrace
.symbol_name
));
365 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_OLD_EVENT
,
368 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_EVENT
, ev
);
371 int kernctl_add_context(int fd
, struct lttng_kernel_context
*ctx
)
373 if (lttng_kernel_use_old_abi
) {
374 struct lttng_kernel_old_context old_ctx
;
376 memset(&old_ctx
, 0, sizeof(old_ctx
));
377 old_ctx
.ctx
= ctx
->ctx
;
378 /* only type that uses the union */
379 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
380 old_ctx
.u
.perf_counter
.type
=
381 ctx
->u
.perf_counter
.type
;
382 old_ctx
.u
.perf_counter
.config
=
383 ctx
->u
.perf_counter
.config
;
384 memcpy(old_ctx
.u
.perf_counter
.name
,
385 ctx
->u
.perf_counter
.name
,
386 sizeof(old_ctx
.u
.perf_counter
.name
));
388 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_OLD_CONTEXT
, &old_ctx
);
390 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_CONTEXT
, ctx
);
394 /* Enable event, channel and session LTTNG_IOCTL_CHECK */
395 int kernctl_enable(int fd
)
397 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_ENABLE
,
398 LTTNG_KERNEL_ENABLE
);
401 /* Disable event, channel and session LTTNG_IOCTL_CHECK */
402 int kernctl_disable(int fd
)
404 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_DISABLE
,
405 LTTNG_KERNEL_DISABLE
);
408 int kernctl_start_session(int fd
)
410 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION_START
,
411 LTTNG_KERNEL_SESSION_START
);
414 int kernctl_stop_session(int fd
)
416 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION_STOP
,
417 LTTNG_KERNEL_SESSION_STOP
);
420 int kernctl_filter(int fd
, struct lttng_filter_bytecode
*filter
)
422 struct lttng_kernel_filter_bytecode
*kb
;
426 /* Translate bytecode to kernel bytecode */
427 kb
= zmalloc(sizeof(*kb
) + filter
->len
);
430 kb
->len
= len
= filter
->len
;
431 kb
->reloc_offset
= filter
->reloc_table_offset
;
432 kb
->seqnum
= filter
->seqnum
;
433 memcpy(kb
->data
, filter
->data
, len
);
434 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_FILTER
, kb
);
439 int kernctl_add_callsite(int fd
, struct lttng_kernel_event_callsite
*callsite
)
441 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_ADD_CALLSITE
, callsite
);
444 int kernctl_tracepoint_list(int fd
)
446 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_TRACEPOINT_LIST
,
447 LTTNG_KERNEL_TRACEPOINT_LIST
);
450 int kernctl_syscall_list(int fd
)
452 return LTTNG_IOCTL_NO_CHECK(fd
, LTTNG_KERNEL_SYSCALL_LIST
);
455 int kernctl_tracer_version(int fd
, struct lttng_kernel_tracer_version
*v
)
459 if (lttng_kernel_use_old_abi
== -1) {
460 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_TRACER_VERSION
, v
);
462 lttng_kernel_use_old_abi
= 0;
465 lttng_kernel_use_old_abi
= 1;
467 if (lttng_kernel_use_old_abi
) {
468 struct lttng_kernel_old_tracer_version old_v
;
470 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_OLD_TRACER_VERSION
, &old_v
);
474 v
->major
= old_v
.major
;
475 v
->minor
= old_v
.minor
;
476 v
->patchlevel
= old_v
.patchlevel
;
478 ret
= LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_TRACER_VERSION
, v
);
485 int kernctl_tracer_abi_version(int fd
,
486 struct lttng_kernel_tracer_abi_version
*v
)
488 return LTTNG_IOCTL_CHECK(fd
, LTTNG_KERNEL_TRACER_ABI_VERSION
, v
);
491 int kernctl_wait_quiescent(int fd
)
493 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_WAIT_QUIESCENT
,
494 LTTNG_KERNEL_WAIT_QUIESCENT
);
497 int kernctl_buffer_flush(int fd
)
499 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_FLUSH
);
502 int kernctl_buffer_flush_empty(int fd
)
504 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_FLUSH_EMPTY
);
507 int kernctl_buffer_clear(int fd
)
509 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_CLEAR
);
512 /* returns the version of the metadata. */
513 int kernctl_get_metadata_version(int fd
, uint64_t *version
)
515 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_METADATA_VERSION
, version
);
518 int kernctl_metadata_cache_dump(int fd
)
520 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_METADATA_CACHE_DUMP
);
523 /* Buffer operations */
525 /* For mmap mode, readable without "get" operation */
527 /* returns the length to mmap. */
528 int kernctl_get_mmap_len(int fd
, unsigned long *len
)
530 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_MMAP_LEN
, len
);
533 /* returns the maximum size for sub-buffers. */
534 int kernctl_get_max_subbuf_size(int fd
, unsigned long *len
)
536 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_MAX_SUBBUF_SIZE
, len
);
540 * For mmap mode, operate on the current packet (between get/put or
541 * get_next/put_next).
544 /* returns the offset of the subbuffer belonging to the mmap reader. */
545 int kernctl_get_mmap_read_offset(int fd
, unsigned long *off
)
547 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_MMAP_READ_OFFSET
, off
);
550 /* returns the size of the current sub-buffer, without padding (for mmap). */
551 int kernctl_get_subbuf_size(int fd
, unsigned long *len
)
553 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_SUBBUF_SIZE
, len
);
556 /* returns the size of the current sub-buffer, without padding (for mmap). */
557 int kernctl_get_padded_subbuf_size(int fd
, unsigned long *len
)
559 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_PADDED_SUBBUF_SIZE
, len
);
562 /* Get exclusive read access to the next sub-buffer that can be read. */
563 int kernctl_get_next_subbuf(int fd
)
565 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_NEXT_SUBBUF
);
569 /* Release exclusive sub-buffer access, move consumer forward. */
570 int kernctl_put_next_subbuf(int fd
)
572 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_PUT_NEXT_SUBBUF
);
577 /* Get a snapshot of the current ring buffer producer and consumer positions */
578 int kernctl_snapshot(int fd
)
580 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_SNAPSHOT
);
584 * Get a snapshot of the current ring buffer producer and consumer positions,
585 * regardless of whether or not the two positions are contained within the
588 int kernctl_snapshot_sample_positions(int fd
)
590 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS
);
593 /* Get the consumer position (iteration start) */
594 int kernctl_snapshot_get_consumed(int fd
, unsigned long *pos
)
596 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_SNAPSHOT_GET_CONSUMED
, pos
);
599 /* Get the producer position (iteration end) */
600 int kernctl_snapshot_get_produced(int fd
, unsigned long *pos
)
602 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_SNAPSHOT_GET_PRODUCED
, pos
);
605 /* Get exclusive read access to the specified sub-buffer position */
606 int kernctl_get_subbuf(int fd
, unsigned long *len
)
608 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_GET_SUBBUF
, len
);
611 /* Release exclusive sub-buffer access */
612 int kernctl_put_subbuf(int fd
)
614 return LTTNG_IOCTL_CHECK(fd
, RING_BUFFER_PUT_SUBBUF
);
617 /* Returns the timestamp begin of the current sub-buffer. */
618 int kernctl_get_timestamp_begin(int fd
, uint64_t *timestamp_begin
)
620 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
,
624 /* Returns the timestamp end of the current sub-buffer. */
625 int kernctl_get_timestamp_end(int fd
, uint64_t *timestamp_end
)
627 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_TIMESTAMP_END
,
631 /* Returns the number of discarded events in the current sub-buffer. */
632 int kernctl_get_events_discarded(int fd
, uint64_t *events_discarded
)
634 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
,
638 /* Returns the content size in the current sub-buffer. */
639 int kernctl_get_content_size(int fd
, uint64_t *content_size
)
641 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_CONTENT_SIZE
,
645 /* Returns the packet size in the current sub-buffer. */
646 int kernctl_get_packet_size(int fd
, uint64_t *packet_size
)
648 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_PACKET_SIZE
,
652 /* Returns the stream id of the current sub-buffer. */
653 int kernctl_get_stream_id(int fd
, uint64_t *stream_id
)
655 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_STREAM_ID
,
659 /* Returns the current timestamp. */
660 int kernctl_get_current_timestamp(int fd
, uint64_t *ts
)
662 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
,
666 /* Returns the packet sequence number of the current sub-buffer. */
667 int kernctl_get_sequence_number(int fd
, uint64_t *seq
)
669 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_GET_SEQ_NUM
, seq
);
672 /* Returns the stream instance id. */
673 int kernctl_get_instance_id(int fd
, uint64_t *id
)
675 return LTTNG_IOCTL_CHECK(fd
, LTTNG_RING_BUFFER_INSTANCE_ID
, id
);