2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #define __USE_LINUX_IOCTL_DEFS
21 #include <sys/ioctl.h>
23 #include <common/align.h>
26 #include "kernel-ctl.h"
27 #include "kernel-ioctl.h"
30 * This flag indicates which version of the kernel ABI to use. The old
31 * ABI (namespace _old) does not support a 32-bit user-space when the
32 * kernel is 64-bit. The old ABI is kept here for compatibility but is
33 * deprecated and will be removed eventually.
35 static int lttng_kernel_use_old_abi
= -1;
38 * Execute the new or old ioctl depending on the ABI version.
39 * If the ABI version is not determined yet (lttng_kernel_use_old_abi = -1),
40 * this function tests if the new ABI is available and otherwise fallbacks
42 * This function takes the fd on which the ioctl must be executed and the old
43 * and new request codes.
44 * It returns the return value of the ioctl executed.
46 static inline int compat_ioctl_no_arg(int fd
, unsigned long oldname
,
47 unsigned long newname
)
51 if (lttng_kernel_use_old_abi
== -1) {
52 ret
= ioctl(fd
, newname
);
54 lttng_kernel_use_old_abi
= 0;
57 lttng_kernel_use_old_abi
= 1;
59 if (lttng_kernel_use_old_abi
) {
60 ret
= ioctl(fd
, oldname
);
62 ret
= ioctl(fd
, newname
);
69 int kernctl_create_session(int fd
)
71 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION
,
72 LTTNG_KERNEL_SESSION
);
75 /* open the metadata global channel */
76 int kernctl_open_metadata(int fd
, struct lttng_channel_attr
*chops
)
78 struct lttng_kernel_old_channel old_channel
;
79 struct lttng_kernel_channel channel
;
81 if (lttng_kernel_use_old_abi
) {
82 old_channel
.overwrite
= chops
->overwrite
;
83 old_channel
.subbuf_size
= chops
->subbuf_size
;
84 old_channel
.num_subbuf
= chops
->num_subbuf
;
85 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
86 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
87 old_channel
.output
= chops
->output
;
89 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
91 * The new channel padding is smaller than the old ABI so we use the
92 * new ABI padding size for the memcpy.
94 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
96 return ioctl(fd
, LTTNG_KERNEL_OLD_METADATA
, &old_channel
);
99 channel
.overwrite
= chops
->overwrite
;
100 channel
.subbuf_size
= chops
->subbuf_size
;
101 channel
.num_subbuf
= chops
->num_subbuf
;
102 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
103 channel
.read_timer_interval
= chops
->read_timer_interval
;
104 channel
.output
= chops
->output
;
105 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
107 return ioctl(fd
, LTTNG_KERNEL_METADATA
, &channel
);
110 int kernctl_create_channel(int fd
, struct lttng_channel_attr
*chops
)
112 struct lttng_kernel_channel channel
;
114 memset(&channel
, 0, sizeof(channel
));
115 if (lttng_kernel_use_old_abi
) {
116 struct lttng_kernel_old_channel old_channel
;
118 old_channel
.overwrite
= chops
->overwrite
;
119 old_channel
.subbuf_size
= chops
->subbuf_size
;
120 old_channel
.num_subbuf
= chops
->num_subbuf
;
121 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
122 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
123 old_channel
.output
= chops
->output
;
125 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
127 * The new channel padding is smaller than the old ABI so we use the
128 * new ABI padding size for the memcpy.
130 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
132 return ioctl(fd
, LTTNG_KERNEL_OLD_CHANNEL
, &old_channel
);
135 channel
.overwrite
= chops
->overwrite
;
136 channel
.subbuf_size
= chops
->subbuf_size
;
137 channel
.num_subbuf
= chops
->num_subbuf
;
138 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
139 channel
.read_timer_interval
= chops
->read_timer_interval
;
140 channel
.output
= chops
->output
;
141 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
143 return ioctl(fd
, LTTNG_KERNEL_CHANNEL
, &channel
);
146 int kernctl_syscall_mask(int fd
, char **syscall_mask
, uint32_t *nr_bits
)
148 struct lttng_kernel_syscall_mask kmask_len
, *kmask
= NULL
;
149 size_t array_alloc_len
;
164 ret
= ioctl(fd
, LTTNG_KERNEL_SYSCALL_MASK
, &kmask_len
);
169 array_alloc_len
= ALIGN(kmask_len
.len
, 8) >> 3;
171 kmask
= zmalloc(sizeof(*kmask
) + array_alloc_len
);
177 kmask
->len
= kmask_len
.len
;
178 ret
= ioctl(fd
, LTTNG_KERNEL_SYSCALL_MASK
, kmask
);
183 new_mask
= realloc(*syscall_mask
, array_alloc_len
);
188 memcpy(new_mask
, kmask
->mask
, array_alloc_len
);
189 *syscall_mask
= new_mask
;
190 *nr_bits
= kmask
->len
;
197 int kernctl_track_pid(int fd
, int pid
)
199 return ioctl(fd
, LTTNG_KERNEL_SESSION_TRACK_PID
, pid
);
202 int kernctl_untrack_pid(int fd
, int pid
)
204 return ioctl(fd
, LTTNG_KERNEL_SESSION_UNTRACK_PID
, pid
);
207 int kernctl_list_tracker_pids(int fd
)
209 return ioctl(fd
, LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS
);
212 int kernctl_session_metadata_regenerate(int fd
)
214 return ioctl(fd
, LTTNG_KERNEL_SESSION_METADATA_REGEN
);
217 int kernctl_create_stream(int fd
)
219 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_STREAM
,
220 LTTNG_KERNEL_STREAM
);
223 int kernctl_create_event(int fd
, struct lttng_kernel_event
*ev
)
225 if (lttng_kernel_use_old_abi
) {
226 struct lttng_kernel_old_event old_event
;
228 memcpy(old_event
.name
, ev
->name
, sizeof(old_event
.name
));
229 old_event
.instrumentation
= ev
->instrumentation
;
230 switch (ev
->instrumentation
) {
231 case LTTNG_KERNEL_KPROBE
:
232 old_event
.u
.kprobe
.addr
= ev
->u
.kprobe
.addr
;
233 old_event
.u
.kprobe
.offset
= ev
->u
.kprobe
.offset
;
234 memcpy(old_event
.u
.kprobe
.symbol_name
,
235 ev
->u
.kprobe
.symbol_name
,
236 sizeof(old_event
.u
.kprobe
.symbol_name
));
238 case LTTNG_KERNEL_KRETPROBE
:
239 old_event
.u
.kretprobe
.addr
= ev
->u
.kretprobe
.addr
;
240 old_event
.u
.kretprobe
.offset
= ev
->u
.kretprobe
.offset
;
241 memcpy(old_event
.u
.kretprobe
.symbol_name
,
242 ev
->u
.kretprobe
.symbol_name
,
243 sizeof(old_event
.u
.kretprobe
.symbol_name
));
245 case LTTNG_KERNEL_FUNCTION
:
246 memcpy(old_event
.u
.ftrace
.symbol_name
,
247 ev
->u
.ftrace
.symbol_name
,
248 sizeof(old_event
.u
.ftrace
.symbol_name
));
254 return ioctl(fd
, LTTNG_KERNEL_OLD_EVENT
, &old_event
);
256 return ioctl(fd
, LTTNG_KERNEL_EVENT
, ev
);
259 int kernctl_add_context(int fd
, struct lttng_kernel_context
*ctx
)
261 if (lttng_kernel_use_old_abi
) {
262 struct lttng_kernel_old_context old_ctx
;
264 old_ctx
.ctx
= ctx
->ctx
;
265 /* only type that uses the union */
266 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
267 old_ctx
.u
.perf_counter
.type
=
268 ctx
->u
.perf_counter
.type
;
269 old_ctx
.u
.perf_counter
.config
=
270 ctx
->u
.perf_counter
.config
;
271 memcpy(old_ctx
.u
.perf_counter
.name
,
272 ctx
->u
.perf_counter
.name
,
273 sizeof(old_ctx
.u
.perf_counter
.name
));
275 return ioctl(fd
, LTTNG_KERNEL_OLD_CONTEXT
, &old_ctx
);
277 return ioctl(fd
, LTTNG_KERNEL_CONTEXT
, ctx
);
281 /* Enable event, channel and session ioctl */
282 int kernctl_enable(int fd
)
284 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_ENABLE
,
285 LTTNG_KERNEL_ENABLE
);
288 /* Disable event, channel and session ioctl */
289 int kernctl_disable(int fd
)
291 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_DISABLE
,
292 LTTNG_KERNEL_DISABLE
);
295 int kernctl_start_session(int fd
)
297 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION_START
,
298 LTTNG_KERNEL_SESSION_START
);
301 int kernctl_stop_session(int fd
)
303 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION_STOP
,
304 LTTNG_KERNEL_SESSION_STOP
);
307 int kernctl_filter(int fd
, struct lttng_filter_bytecode
*filter
)
309 struct lttng_kernel_filter_bytecode
*kb
;
313 /* Translate bytecode to kernel bytecode */
314 kb
= zmalloc(sizeof(*kb
) + filter
->len
);
317 kb
->len
= len
= filter
->len
;
318 kb
->reloc_offset
= filter
->reloc_table_offset
;
319 kb
->seqnum
= filter
->seqnum
;
320 memcpy(kb
->data
, filter
->data
, len
);
321 ret
= ioctl(fd
, LTTNG_KERNEL_FILTER
, kb
);
326 int kernctl_tracepoint_list(int fd
)
328 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_TRACEPOINT_LIST
,
329 LTTNG_KERNEL_TRACEPOINT_LIST
);
332 int kernctl_syscall_list(int fd
)
334 return ioctl(fd
, LTTNG_KERNEL_SYSCALL_LIST
);
337 int kernctl_tracer_version(int fd
, struct lttng_kernel_tracer_version
*v
)
341 if (lttng_kernel_use_old_abi
== -1) {
342 ret
= ioctl(fd
, LTTNG_KERNEL_TRACER_VERSION
, v
);
344 lttng_kernel_use_old_abi
= 0;
347 lttng_kernel_use_old_abi
= 1;
349 if (lttng_kernel_use_old_abi
) {
350 struct lttng_kernel_old_tracer_version old_v
;
352 ret
= ioctl(fd
, LTTNG_KERNEL_OLD_TRACER_VERSION
, &old_v
);
356 v
->major
= old_v
.major
;
357 v
->minor
= old_v
.minor
;
358 v
->patchlevel
= old_v
.patchlevel
;
360 ret
= ioctl(fd
, LTTNG_KERNEL_TRACER_VERSION
, v
);
367 int kernctl_tracer_abi_version(int fd
,
368 struct lttng_kernel_tracer_abi_version
*v
)
370 return ioctl(fd
, LTTNG_KERNEL_TRACER_ABI_VERSION
, v
);
373 int kernctl_wait_quiescent(int fd
)
375 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_WAIT_QUIESCENT
,
376 LTTNG_KERNEL_WAIT_QUIESCENT
);
379 int kernctl_calibrate(int fd
, struct lttng_kernel_calibrate
*calibrate
)
383 if (lttng_kernel_use_old_abi
== -1) {
384 ret
= ioctl(fd
, LTTNG_KERNEL_CALIBRATE
, calibrate
);
386 lttng_kernel_use_old_abi
= 0;
389 lttng_kernel_use_old_abi
= 1;
391 if (lttng_kernel_use_old_abi
) {
392 struct lttng_kernel_old_calibrate old_calibrate
;
394 old_calibrate
.type
= calibrate
->type
;
395 ret
= ioctl(fd
, LTTNG_KERNEL_OLD_CALIBRATE
, &old_calibrate
);
399 calibrate
->type
= old_calibrate
.type
;
401 ret
= ioctl(fd
, LTTNG_KERNEL_CALIBRATE
, calibrate
);
409 int kernctl_buffer_flush(int fd
)
411 return ioctl(fd
, RING_BUFFER_FLUSH
);
414 /* returns the version of the metadata. */
415 int kernctl_get_metadata_version(int fd
, uint64_t *version
)
417 return ioctl(fd
, RING_BUFFER_GET_METADATA_VERSION
, version
);
421 /* Buffer operations */
423 /* For mmap mode, readable without "get" operation */
425 /* returns the length to mmap. */
426 int kernctl_get_mmap_len(int fd
, unsigned long *len
)
428 return ioctl(fd
, RING_BUFFER_GET_MMAP_LEN
, len
);
431 /* returns the maximum size for sub-buffers. */
432 int kernctl_get_max_subbuf_size(int fd
, unsigned long *len
)
434 return ioctl(fd
, RING_BUFFER_GET_MAX_SUBBUF_SIZE
, len
);
438 * For mmap mode, operate on the current packet (between get/put or
439 * get_next/put_next).
442 /* returns the offset of the subbuffer belonging to the mmap reader. */
443 int kernctl_get_mmap_read_offset(int fd
, unsigned long *off
)
445 return ioctl(fd
, RING_BUFFER_GET_MMAP_READ_OFFSET
, off
);
448 /* returns the size of the current sub-buffer, without padding (for mmap). */
449 int kernctl_get_subbuf_size(int fd
, unsigned long *len
)
451 return ioctl(fd
, RING_BUFFER_GET_SUBBUF_SIZE
, len
);
454 /* returns the size of the current sub-buffer, without padding (for mmap). */
455 int kernctl_get_padded_subbuf_size(int fd
, unsigned long *len
)
457 return ioctl(fd
, RING_BUFFER_GET_PADDED_SUBBUF_SIZE
, len
);
460 /* Get exclusive read access to the next sub-buffer that can be read. */
461 int kernctl_get_next_subbuf(int fd
)
463 return ioctl(fd
, RING_BUFFER_GET_NEXT_SUBBUF
);
467 /* Release exclusive sub-buffer access, move consumer forward. */
468 int kernctl_put_next_subbuf(int fd
)
470 return ioctl(fd
, RING_BUFFER_PUT_NEXT_SUBBUF
);
475 /* Get a snapshot of the current ring buffer producer and consumer positions */
476 int kernctl_snapshot(int fd
)
478 return ioctl(fd
, RING_BUFFER_SNAPSHOT
);
481 /* Get the consumer position (iteration start) */
482 int kernctl_snapshot_get_consumed(int fd
, unsigned long *pos
)
484 return ioctl(fd
, RING_BUFFER_SNAPSHOT_GET_CONSUMED
, pos
);
487 /* Get the producer position (iteration end) */
488 int kernctl_snapshot_get_produced(int fd
, unsigned long *pos
)
490 return ioctl(fd
, RING_BUFFER_SNAPSHOT_GET_PRODUCED
, pos
);
493 /* Get exclusive read access to the specified sub-buffer position */
494 int kernctl_get_subbuf(int fd
, unsigned long *len
)
496 return ioctl(fd
, RING_BUFFER_GET_SUBBUF
, len
);
499 /* Release exclusive sub-buffer access */
500 int kernctl_put_subbuf(int fd
)
502 return ioctl(fd
, RING_BUFFER_PUT_SUBBUF
);
505 /* Returns the timestamp begin of the current sub-buffer. */
506 int kernctl_get_timestamp_begin(int fd
, uint64_t *timestamp_begin
)
508 return ioctl(fd
, LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
, timestamp_begin
);
511 /* Returns the timestamp end of the current sub-buffer. */
512 int kernctl_get_timestamp_end(int fd
, uint64_t *timestamp_end
)
514 return ioctl(fd
, LTTNG_RING_BUFFER_GET_TIMESTAMP_END
, timestamp_end
);
517 /* Returns the number of discarded events in the current sub-buffer. */
518 int kernctl_get_events_discarded(int fd
, uint64_t *events_discarded
)
520 return ioctl(fd
, LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
, events_discarded
);
523 /* Returns the content size in the current sub-buffer. */
524 int kernctl_get_content_size(int fd
, uint64_t *content_size
)
526 return ioctl(fd
, LTTNG_RING_BUFFER_GET_CONTENT_SIZE
, content_size
);
529 /* Returns the packet size in the current sub-buffer. */
530 int kernctl_get_packet_size(int fd
, uint64_t *packet_size
)
532 return ioctl(fd
, LTTNG_RING_BUFFER_GET_PACKET_SIZE
, packet_size
);
535 /* Returns the stream id of the current sub-buffer. */
536 int kernctl_get_stream_id(int fd
, uint64_t *stream_id
)
538 return ioctl(fd
, LTTNG_RING_BUFFER_GET_STREAM_ID
, stream_id
);
541 /* Returns the current timestamp. */
542 int kernctl_get_current_timestamp(int fd
, uint64_t *ts
)
544 return ioctl(fd
, LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
, ts
);
547 /* Returns the packet sequence number of the current sub-buffer. */
548 int kernctl_get_sequence_number(int fd
, uint64_t *seq
)
550 return ioctl(fd
, LTTNG_RING_BUFFER_GET_SEQ_NUM
, seq
);
553 /* Returns the stream instance id. */
554 int kernctl_get_instance_id(int fd
, uint64_t *id
)
556 return ioctl(fd
, LTTNG_RING_BUFFER_INSTANCE_ID
, id
);