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.
19 #define __USE_LINUX_IOCTL_DEFS
20 #include <sys/ioctl.h>
23 #include "kernel-ctl.h"
24 #include "kernel-ioctl.h"
27 * This flag indicates which version of the kernel ABI to use. The old
28 * ABI (namespace _old) does not support a 32-bit user-space when the
29 * kernel is 64-bit. The old ABI is kept here for compatibility but is
30 * deprecated and will be removed eventually.
32 static int lttng_kernel_use_old_abi
= -1;
35 * Execute the new or old ioctl depending on the ABI version.
36 * If the ABI version is not determined yet (lttng_kernel_use_old_abi = -1),
37 * this function tests if the new ABI is available and otherwise fallbacks
39 * This function takes the fd on which the ioctl must be executed and the old
40 * and new request codes.
41 * It returns the return value of the ioctl executed.
43 static inline int compat_ioctl_no_arg(int fd
, unsigned long oldname
,
44 unsigned long newname
)
48 if (lttng_kernel_use_old_abi
== -1) {
49 ret
= ioctl(fd
, newname
);
51 lttng_kernel_use_old_abi
= 0;
54 lttng_kernel_use_old_abi
= 1;
56 if (lttng_kernel_use_old_abi
) {
57 ret
= ioctl(fd
, oldname
);
59 ret
= ioctl(fd
, newname
);
66 int kernctl_create_session(int fd
)
68 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION
,
69 LTTNG_KERNEL_SESSION
);
72 /* open the metadata global channel */
73 int kernctl_open_metadata(int fd
, struct lttng_channel_attr
*chops
)
75 struct lttng_kernel_old_channel old_channel
;
76 struct lttng_kernel_channel channel
;
78 if (lttng_kernel_use_old_abi
) {
79 old_channel
.overwrite
= chops
->overwrite
;
80 old_channel
.subbuf_size
= chops
->subbuf_size
;
81 old_channel
.num_subbuf
= chops
->num_subbuf
;
82 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
83 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
84 old_channel
.output
= chops
->output
;
86 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
88 * The new channel padding is smaller than the old ABI so we use the
89 * new ABI padding size for the memcpy.
91 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
93 return ioctl(fd
, LTTNG_KERNEL_OLD_METADATA
, &old_channel
);
96 channel
.overwrite
= chops
->overwrite
;
97 channel
.subbuf_size
= chops
->subbuf_size
;
98 channel
.num_subbuf
= chops
->num_subbuf
;
99 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
100 channel
.read_timer_interval
= chops
->read_timer_interval
;
101 channel
.output
= chops
->output
;
102 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
104 return ioctl(fd
, LTTNG_KERNEL_METADATA
, &channel
);
107 int kernctl_create_channel(int fd
, struct lttng_channel_attr
*chops
)
109 struct lttng_kernel_channel channel
;
111 if (lttng_kernel_use_old_abi
) {
112 struct lttng_kernel_old_channel old_channel
;
114 old_channel
.overwrite
= chops
->overwrite
;
115 old_channel
.subbuf_size
= chops
->subbuf_size
;
116 old_channel
.num_subbuf
= chops
->num_subbuf
;
117 old_channel
.switch_timer_interval
= chops
->switch_timer_interval
;
118 old_channel
.read_timer_interval
= chops
->read_timer_interval
;
119 old_channel
.output
= chops
->output
;
121 memset(old_channel
.padding
, 0, sizeof(old_channel
.padding
));
123 * The new channel padding is smaller than the old ABI so we use the
124 * new ABI padding size for the memcpy.
126 memcpy(old_channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
128 return ioctl(fd
, LTTNG_KERNEL_OLD_CHANNEL
, &old_channel
);
131 channel
.overwrite
= chops
->overwrite
;
132 channel
.subbuf_size
= chops
->subbuf_size
;
133 channel
.num_subbuf
= chops
->num_subbuf
;
134 channel
.switch_timer_interval
= chops
->switch_timer_interval
;
135 channel
.read_timer_interval
= chops
->read_timer_interval
;
136 channel
.output
= chops
->output
;
137 memcpy(channel
.padding
, chops
->padding
, sizeof(chops
->padding
));
139 return ioctl(fd
, LTTNG_KERNEL_CHANNEL
, &channel
);
142 int kernctl_enable_syscall(int fd
, const char *syscall_name
)
144 struct lttng_kernel_event event
;
146 memset(&event
, 0, sizeof(event
));
147 strncpy(event
.name
, syscall_name
, sizeof(event
.name
));
148 event
.name
[sizeof(event
.name
) - 1] = '\0';
149 event
.instrumentation
= LTTNG_KERNEL_SYSCALL
;
150 event
.u
.syscall
.disable
= 0;
151 return ioctl(fd
, LTTNG_KERNEL_EVENT
, &event
);
154 int kernctl_disable_syscall(int fd
, const char *syscall_name
)
156 struct lttng_kernel_event event
;
158 memset(&event
, 0, sizeof(event
));
159 strncpy(event
.name
, syscall_name
, sizeof(event
.name
));
160 event
.name
[sizeof(event
.name
) - 1] = '\0';
161 event
.instrumentation
= LTTNG_KERNEL_SYSCALL
;
162 event
.u
.syscall
.disable
= 1;
163 return ioctl(fd
, LTTNG_KERNEL_EVENT
, &event
);
166 int kernctl_create_stream(int fd
)
168 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_STREAM
,
169 LTTNG_KERNEL_STREAM
);
172 int kernctl_create_event(int fd
, struct lttng_kernel_event
*ev
)
174 if (lttng_kernel_use_old_abi
) {
175 struct lttng_kernel_old_event old_event
;
177 memcpy(old_event
.name
, ev
->name
, sizeof(old_event
.name
));
178 old_event
.instrumentation
= ev
->instrumentation
;
179 switch (ev
->instrumentation
) {
180 case LTTNG_KERNEL_KPROBE
:
181 old_event
.u
.kprobe
.addr
= ev
->u
.kprobe
.addr
;
182 old_event
.u
.kprobe
.offset
= ev
->u
.kprobe
.offset
;
183 memcpy(old_event
.u
.kprobe
.symbol_name
,
184 ev
->u
.kprobe
.symbol_name
,
185 sizeof(old_event
.u
.kprobe
.symbol_name
));
187 case LTTNG_KERNEL_KRETPROBE
:
188 old_event
.u
.kretprobe
.addr
= ev
->u
.kretprobe
.addr
;
189 old_event
.u
.kretprobe
.offset
= ev
->u
.kretprobe
.offset
;
190 memcpy(old_event
.u
.kretprobe
.symbol_name
,
191 ev
->u
.kretprobe
.symbol_name
,
192 sizeof(old_event
.u
.kretprobe
.symbol_name
));
194 case LTTNG_KERNEL_FUNCTION
:
195 memcpy(old_event
.u
.ftrace
.symbol_name
,
196 ev
->u
.ftrace
.symbol_name
,
197 sizeof(old_event
.u
.ftrace
.symbol_name
));
203 return ioctl(fd
, LTTNG_KERNEL_OLD_EVENT
, &old_event
);
205 return ioctl(fd
, LTTNG_KERNEL_EVENT
, ev
);
208 int kernctl_add_context(int fd
, struct lttng_kernel_context
*ctx
)
210 if (lttng_kernel_use_old_abi
) {
211 struct lttng_kernel_old_context old_ctx
;
213 old_ctx
.ctx
= ctx
->ctx
;
214 /* only type that uses the union */
215 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
216 old_ctx
.u
.perf_counter
.type
=
217 ctx
->u
.perf_counter
.type
;
218 old_ctx
.u
.perf_counter
.config
=
219 ctx
->u
.perf_counter
.config
;
220 memcpy(old_ctx
.u
.perf_counter
.name
,
221 ctx
->u
.perf_counter
.name
,
222 sizeof(old_ctx
.u
.perf_counter
.name
));
224 return ioctl(fd
, LTTNG_KERNEL_OLD_CONTEXT
, &old_ctx
);
226 return ioctl(fd
, LTTNG_KERNEL_CONTEXT
, ctx
);
230 /* Enable event, channel and session ioctl */
231 int kernctl_enable(int fd
)
233 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_ENABLE
,
234 LTTNG_KERNEL_ENABLE
);
237 /* Disable event, channel and session ioctl */
238 int kernctl_disable(int fd
)
240 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_DISABLE
,
241 LTTNG_KERNEL_DISABLE
);
244 int kernctl_start_session(int fd
)
246 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION_START
,
247 LTTNG_KERNEL_SESSION_START
);
250 int kernctl_stop_session(int fd
)
252 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_SESSION_STOP
,
253 LTTNG_KERNEL_SESSION_STOP
);
256 int kernctl_tracepoint_list(int fd
)
258 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_TRACEPOINT_LIST
,
259 LTTNG_KERNEL_TRACEPOINT_LIST
);
262 int kernctl_tracer_version(int fd
, struct lttng_kernel_tracer_version
*v
)
266 if (lttng_kernel_use_old_abi
== -1) {
267 ret
= ioctl(fd
, LTTNG_KERNEL_TRACER_VERSION
, v
);
269 lttng_kernel_use_old_abi
= 0;
272 lttng_kernel_use_old_abi
= 1;
274 if (lttng_kernel_use_old_abi
) {
275 struct lttng_kernel_old_tracer_version old_v
;
277 ret
= ioctl(fd
, LTTNG_KERNEL_OLD_TRACER_VERSION
, &old_v
);
281 v
->major
= old_v
.major
;
282 v
->minor
= old_v
.minor
;
283 v
->patchlevel
= old_v
.patchlevel
;
285 ret
= ioctl(fd
, LTTNG_KERNEL_TRACER_VERSION
, v
);
292 int kernctl_wait_quiescent(int fd
)
294 return compat_ioctl_no_arg(fd
, LTTNG_KERNEL_OLD_WAIT_QUIESCENT
,
295 LTTNG_KERNEL_WAIT_QUIESCENT
);
298 int kernctl_calibrate(int fd
, struct lttng_kernel_calibrate
*calibrate
)
302 if (lttng_kernel_use_old_abi
== -1) {
303 ret
= ioctl(fd
, LTTNG_KERNEL_CALIBRATE
, calibrate
);
305 lttng_kernel_use_old_abi
= 0;
308 lttng_kernel_use_old_abi
= 1;
310 if (lttng_kernel_use_old_abi
) {
311 struct lttng_kernel_old_calibrate old_calibrate
;
313 old_calibrate
.type
= calibrate
->type
;
314 ret
= ioctl(fd
, LTTNG_KERNEL_OLD_CALIBRATE
, &old_calibrate
);
318 calibrate
->type
= old_calibrate
.type
;
320 ret
= ioctl(fd
, LTTNG_KERNEL_CALIBRATE
, calibrate
);
328 int kernctl_buffer_flush(int fd
)
330 return ioctl(fd
, RING_BUFFER_FLUSH
);
334 /* Buffer operations */
336 /* For mmap mode, readable without "get" operation */
338 /* returns the length to mmap. */
339 int kernctl_get_mmap_len(int fd
, unsigned long *len
)
341 return ioctl(fd
, RING_BUFFER_GET_MMAP_LEN
, len
);
344 /* returns the maximum size for sub-buffers. */
345 int kernctl_get_max_subbuf_size(int fd
, unsigned long *len
)
347 return ioctl(fd
, RING_BUFFER_GET_MAX_SUBBUF_SIZE
, len
);
351 * For mmap mode, operate on the current packet (between get/put or
352 * get_next/put_next).
355 /* returns the offset of the subbuffer belonging to the mmap reader. */
356 int kernctl_get_mmap_read_offset(int fd
, unsigned long *off
)
358 return ioctl(fd
, RING_BUFFER_GET_MMAP_READ_OFFSET
, off
);
361 /* returns the size of the current sub-buffer, without padding (for mmap). */
362 int kernctl_get_subbuf_size(int fd
, unsigned long *len
)
364 return ioctl(fd
, RING_BUFFER_GET_SUBBUF_SIZE
, len
);
367 /* returns the size of the current sub-buffer, without padding (for mmap). */
368 int kernctl_get_padded_subbuf_size(int fd
, unsigned long *len
)
370 return ioctl(fd
, RING_BUFFER_GET_PADDED_SUBBUF_SIZE
, len
);
373 /* Get exclusive read access to the next sub-buffer that can be read. */
374 int kernctl_get_next_subbuf(int fd
)
376 return ioctl(fd
, RING_BUFFER_GET_NEXT_SUBBUF
);
380 /* Release exclusive sub-buffer access, move consumer forward. */
381 int kernctl_put_next_subbuf(int fd
)
383 return ioctl(fd
, RING_BUFFER_PUT_NEXT_SUBBUF
);
388 /* Get a snapshot of the current ring buffer producer and consumer positions */
389 int kernctl_snapshot(int fd
)
391 return ioctl(fd
, RING_BUFFER_SNAPSHOT
);
394 /* Get the consumer position (iteration start) */
395 int kernctl_snapshot_get_consumed(int fd
, unsigned long *pos
)
397 return ioctl(fd
, RING_BUFFER_SNAPSHOT_GET_CONSUMED
, pos
);
400 /* Get the producer position (iteration end) */
401 int kernctl_snapshot_get_produced(int fd
, unsigned long *pos
)
403 return ioctl(fd
, RING_BUFFER_SNAPSHOT_GET_PRODUCED
, pos
);
406 /* Get exclusive read access to the specified sub-buffer position */
407 int kernctl_get_subbuf(int fd
, unsigned long *len
)
409 return ioctl(fd
, RING_BUFFER_GET_SUBBUF
, len
);
412 /* Release exclusive sub-buffer access */
413 int kernctl_put_subbuf(int fd
)
415 return ioctl(fd
, RING_BUFFER_PUT_SUBBUF
);
418 /* Returns the timestamp begin of the current sub-buffer. */
419 int kernctl_get_timestamp_begin(int fd
, uint64_t *timestamp_begin
)
421 return ioctl(fd
, LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
, timestamp_begin
);
424 /* Returns the timestamp end of the current sub-buffer. */
425 int kernctl_get_timestamp_end(int fd
, uint64_t *timestamp_end
)
427 return ioctl(fd
, LTTNG_RING_BUFFER_GET_TIMESTAMP_END
, timestamp_end
);
430 /* Returns the number of discarded events in the current sub-buffer. */
431 int kernctl_get_events_discarded(int fd
, uint64_t *events_discarded
)
433 return ioctl(fd
, LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
, events_discarded
);
436 /* Returns the content size in the current sub-buffer. */
437 int kernctl_get_content_size(int fd
, uint64_t *content_size
)
439 return ioctl(fd
, LTTNG_RING_BUFFER_GET_CONTENT_SIZE
, content_size
);
442 /* Returns the packet size in the current sub-buffer. */
443 int kernctl_get_packet_size(int fd
, uint64_t *packet_size
)
445 return ioctl(fd
, LTTNG_RING_BUFFER_GET_PACKET_SIZE
, packet_size
);
448 /* Returns the stream id of the current sub-buffer. */
449 int kernctl_get_stream_id(int fd
, uint64_t *stream_id
)
451 return ioctl(fd
, LTTNG_RING_BUFFER_GET_STREAM_ID
, stream_id
);
454 /* Returns the current timestamp. */
455 int kernctl_get_current_timestamp(int fd
, uint64_t *ts
)
457 return ioctl(fd
, LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
, ts
);