4 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * Mimic system calls for:
9 * - session creation, returns a file descriptor or failure.
10 * - channel creation, returns a file descriptor or failure.
11 * - Operates on a session file descriptor
12 * - Takes all channel options as parameters.
13 * - stream get, returns a file descriptor or failure.
14 * - Operates on a channel file descriptor.
15 * - stream notifier get, returns a file descriptor or failure.
16 * - Operates on a channel file descriptor.
17 * - event creation, returns a file descriptor or failure.
18 * - Operates on a channel file descriptor
19 * - Takes an event name as parameter
20 * - Takes an instrumentation source as parameter
21 * - e.g. tracepoints, dynamic_probes...
22 * - Takes instrumentation source specific arguments.
24 * Dual LGPL v2.1/GPL v2 license.
27 #include <linux/module.h>
28 #include <linux/debugfs.h>
29 #include <linux/anon_inodes.h>
30 #include <linux/file.h>
31 #include <linux/uaccess.h>
32 #include <linux/slab.h>
33 #include "wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */
34 #include "wrapper/ringbuffer/vfs.h"
35 #include "wrapper/poll.h"
36 #include "ltt-debugfs-abi.h"
37 #include "ltt-events.h"
38 #include "ltt-tracer.h"
41 * This is LTTng's own personal way to create a system call as an external
42 * module. We use ioctl() on /sys/kernel/debug/lttng.
45 static struct dentry
*lttng_dentry
;
46 static const struct file_operations lttng_fops
;
47 static const struct file_operations lttng_session_fops
;
48 static const struct file_operations lttng_channel_fops
;
49 static const struct file_operations lttng_metadata_fops
;
50 static const struct file_operations lttng_event_fops
;
53 * Teardown management: opened file descriptors keep a refcount on the module,
54 * so it can only exit when all file descriptors are closed.
63 int lttng_abi_create_session(void)
65 struct ltt_session
*session
;
66 struct file
*session_file
;
69 session
= ltt_session_create();
72 session_fd
= get_unused_fd();
77 session_file
= anon_inode_getfile("[lttng_session]",
80 if (IS_ERR(session_file
)) {
81 ret
= PTR_ERR(session_file
);
84 session
->file
= session_file
;
85 fd_install(session_fd
, session_file
);
89 put_unused_fd(session_fd
);
91 ltt_session_destroy(session
);
96 int lttng_abi_tracepoint_list(void)
98 struct file
*tracepoint_list_file
;
101 file_fd
= get_unused_fd();
107 tracepoint_list_file
= anon_inode_getfile("[lttng_session]",
108 <tng_tracepoint_list_fops
,
110 if (IS_ERR(tracepoint_list_file
)) {
111 ret
= PTR_ERR(tracepoint_list_file
);
114 ret
= lttng_tracepoint_list_fops
.open(NULL
, tracepoint_list_file
);
117 fd_install(file_fd
, tracepoint_list_file
);
125 fput(tracepoint_list_file
);
127 put_unused_fd(file_fd
);
133 long lttng_abi_tracer_version(struct file
*file
,
134 struct lttng_kernel_tracer_version __user
*uversion_param
)
136 struct lttng_kernel_tracer_version v
;
138 v
.version
= LTTNG_VERSION
;
139 v
.patchlevel
= LTTNG_PATCHLEVEL
;
140 v
.sublevel
= LTTNG_SUBLEVEL
;
142 if (copy_to_user(uversion_param
, &v
, sizeof(v
)))
148 long lttng_abi_add_context(struct file
*file
,
149 struct lttng_kernel_context __user
*ucontext_param
,
150 struct lttng_ctx
**ctx
, struct ltt_session
*session
)
152 struct lttng_kernel_context context_param
;
154 if (session
->been_active
)
157 if (copy_from_user(&context_param
, ucontext_param
, sizeof(context_param
)))
160 switch (context_param
.ctx
) {
161 case LTTNG_KERNEL_CONTEXT_PID
:
162 return lttng_add_pid_to_ctx(ctx
);
163 case LTTNG_KERNEL_CONTEXT_PRIO
:
164 return lttng_add_prio_to_ctx(ctx
);
165 case LTTNG_KERNEL_CONTEXT_NICE
:
166 return lttng_add_nice_to_ctx(ctx
);
167 case LTTNG_KERNEL_CONTEXT_VPID
:
168 return lttng_add_vpid_to_ctx(ctx
);
169 case LTTNG_KERNEL_CONTEXT_TID
:
170 return lttng_add_tid_to_ctx(ctx
);
171 case LTTNG_KERNEL_CONTEXT_VTID
:
172 return lttng_add_vtid_to_ctx(ctx
);
173 case LTTNG_KERNEL_CONTEXT_PPID
:
174 return lttng_add_ppid_to_ctx(ctx
);
175 case LTTNG_KERNEL_CONTEXT_VPPID
:
176 return lttng_add_vppid_to_ctx(ctx
);
177 case LTTNG_KERNEL_CONTEXT_PERF_COUNTER
:
178 context_param
.u
.perf_counter
.name
[LTTNG_SYM_NAME_LEN
- 1] = '\0';
179 return lttng_add_perf_counter_to_ctx(context_param
.u
.perf_counter
.type
,
180 context_param
.u
.perf_counter
.config
,
181 context_param
.u
.perf_counter
.name
,
183 case LTTNG_KERNEL_CONTEXT_COMM
:
184 return lttng_add_comm_to_ctx(ctx
);
191 * lttng_ioctl - lttng syscall through ioctl
197 * This ioctl implements lttng commands:
198 * LTTNG_KERNEL_SESSION
199 * Returns a LTTng trace session file descriptor
200 * LTTNG_KERNEL_TRACER_VERSION
201 * Returns the LTTng kernel tracer version
202 * LTTNG_KERNEL_TRACEPOINT_LIST
203 * Returns a file descriptor listing available tracepoints
204 * LTTNG_KERNEL_WAIT_QUIESCENT
205 * Returns after all previously running probes have completed
207 * The returned session will be deleted when its file descriptor is closed.
210 long lttng_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
213 case LTTNG_KERNEL_SESSION
:
214 return lttng_abi_create_session();
215 case LTTNG_KERNEL_TRACER_VERSION
:
216 return lttng_abi_tracer_version(file
,
217 (struct lttng_kernel_tracer_version __user
*) arg
);
218 case LTTNG_KERNEL_TRACEPOINT_LIST
:
219 return lttng_abi_tracepoint_list();
220 case LTTNG_KERNEL_WAIT_QUIESCENT
:
223 case LTTNG_KERNEL_CALIBRATE
:
225 struct lttng_kernel_calibrate __user
*ucalibrate
=
226 (struct lttng_kernel_calibrate __user
*) arg
;
227 struct lttng_kernel_calibrate calibrate
;
230 if (copy_from_user(&calibrate
, ucalibrate
, sizeof(calibrate
)))
232 ret
= lttng_calibrate(&calibrate
);
233 if (copy_to_user(ucalibrate
, &calibrate
, sizeof(calibrate
)))
242 static const struct file_operations lttng_fops
= {
243 .owner
= THIS_MODULE
,
244 .unlocked_ioctl
= lttng_ioctl
,
246 .compat_ioctl
= lttng_ioctl
,
251 * We tolerate no failure in this function (if one happens, we print a dmesg
252 * error, but cannot return any error, because the channel information is
256 void lttng_metadata_create_events(struct file
*channel_file
)
258 struct ltt_channel
*channel
= channel_file
->private_data
;
259 static struct lttng_kernel_event metadata_params
= {
260 .instrumentation
= LTTNG_KERNEL_TRACEPOINT
,
261 .name
= "lttng_metadata",
263 struct ltt_event
*event
;
266 * We tolerate no failure path after event creation. It will stay
267 * invariant for the rest of the session.
269 event
= ltt_event_create(channel
, &metadata_params
, NULL
);
277 return; /* not allowed to return error */
281 int lttng_abi_create_channel(struct file
*session_file
,
282 struct lttng_kernel_channel __user
*uchan_param
,
283 enum channel_type channel_type
)
285 struct ltt_session
*session
= session_file
->private_data
;
286 const struct file_operations
*fops
= NULL
;
287 const char *transport_name
;
288 struct ltt_channel
*chan
;
289 struct file
*chan_file
;
290 struct lttng_kernel_channel chan_param
;
294 if (copy_from_user(&chan_param
, uchan_param
, sizeof(chan_param
)))
296 chan_fd
= get_unused_fd();
301 switch (channel_type
) {
302 case PER_CPU_CHANNEL
:
303 fops
= <tng_channel_fops
;
305 case METADATA_CHANNEL
:
306 fops
= <tng_metadata_fops
;
310 chan_file
= anon_inode_getfile("[lttng_channel]",
313 if (IS_ERR(chan_file
)) {
314 ret
= PTR_ERR(chan_file
);
317 switch (channel_type
) {
318 case PER_CPU_CHANNEL
:
319 if (chan_param
.output
== LTTNG_KERNEL_SPLICE
) {
320 transport_name
= chan_param
.overwrite
?
321 "relay-overwrite" : "relay-discard";
322 } else if (chan_param
.output
== LTTNG_KERNEL_MMAP
) {
323 transport_name
= chan_param
.overwrite
?
324 "relay-overwrite-mmap" : "relay-discard-mmap";
329 case METADATA_CHANNEL
:
330 if (chan_param
.output
== LTTNG_KERNEL_SPLICE
)
331 transport_name
= "relay-metadata";
332 else if (chan_param
.output
== LTTNG_KERNEL_MMAP
)
333 transport_name
= "relay-metadata-mmap";
338 transport_name
= "<unknown>";
342 * We tolerate no failure path after channel creation. It will stay
343 * invariant for the rest of the session.
345 chan
= ltt_channel_create(session
, transport_name
, NULL
,
346 chan_param
.subbuf_size
,
347 chan_param
.num_subbuf
,
348 chan_param
.switch_timer_interval
,
349 chan_param
.read_timer_interval
);
354 chan
->file
= chan_file
;
355 chan_file
->private_data
= chan
;
356 fd_install(chan_fd
, chan_file
);
357 if (channel_type
== METADATA_CHANNEL
) {
358 session
->metadata
= chan
;
359 lttng_metadata_create_events(chan_file
);
362 /* The channel created holds a reference on the session */
363 atomic_long_inc(&session_file
->f_count
);
370 put_unused_fd(chan_fd
);
376 * lttng_session_ioctl - lttng session fd ioctl
382 * This ioctl implements lttng commands:
383 * LTTNG_KERNEL_CHANNEL
384 * Returns a LTTng channel file descriptor
385 * LTTNG_KERNEL_ENABLE
386 * Enables tracing for a session (weak enable)
387 * LTTNG_KERNEL_DISABLE
388 * Disables tracing for a session (strong disable)
389 * LTTNG_KERNEL_METADATA
390 * Returns a LTTng metadata file descriptor
392 * The returned channel will be deleted when its file descriptor is closed.
395 long lttng_session_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
397 struct ltt_session
*session
= file
->private_data
;
400 case LTTNG_KERNEL_CHANNEL
:
401 return lttng_abi_create_channel(file
,
402 (struct lttng_kernel_channel __user
*) arg
,
404 case LTTNG_KERNEL_SESSION_START
:
405 case LTTNG_KERNEL_ENABLE
:
406 return ltt_session_enable(session
);
407 case LTTNG_KERNEL_SESSION_STOP
:
408 case LTTNG_KERNEL_DISABLE
:
409 return ltt_session_disable(session
);
410 case LTTNG_KERNEL_METADATA
:
411 return lttng_abi_create_channel(file
,
412 (struct lttng_kernel_channel __user
*) arg
,
420 * Called when the last file reference is dropped.
422 * Big fat note: channels and events are invariant for the whole session after
423 * their creation. So this session destruction also destroys all channel and
424 * event structures specific to this session (they are not destroyed when their
425 * individual file is released).
428 int lttng_session_release(struct inode
*inode
, struct file
*file
)
430 struct ltt_session
*session
= file
->private_data
;
433 ltt_session_destroy(session
);
437 static const struct file_operations lttng_session_fops
= {
438 .owner
= THIS_MODULE
,
439 .release
= lttng_session_release
,
440 .unlocked_ioctl
= lttng_session_ioctl
,
442 .compat_ioctl
= lttng_session_ioctl
,
447 int lttng_abi_open_stream(struct file
*channel_file
)
449 struct ltt_channel
*channel
= channel_file
->private_data
;
450 struct lib_ring_buffer
*buf
;
452 struct file
*stream_file
;
454 buf
= channel
->ops
->buffer_read_open(channel
->chan
);
458 stream_fd
= get_unused_fd();
463 stream_file
= anon_inode_getfile("[lttng_stream]",
464 &lib_ring_buffer_file_operations
,
466 if (IS_ERR(stream_file
)) {
467 ret
= PTR_ERR(stream_file
);
471 * OPEN_FMODE, called within anon_inode_getfile/alloc_file, don't honor
472 * FMODE_LSEEK, FMODE_PREAD nor FMODE_PWRITE. We need to read from this
473 * file descriptor, so we set FMODE_PREAD here.
475 stream_file
->f_mode
|= FMODE_PREAD
;
476 fd_install(stream_fd
, stream_file
);
478 * The stream holds a reference to the channel within the generic ring
479 * buffer library, so no need to hold a refcount on the channel and
480 * session files here.
485 put_unused_fd(stream_fd
);
487 channel
->ops
->buffer_read_close(buf
);
492 int lttng_abi_create_event(struct file
*channel_file
,
493 struct lttng_kernel_event __user
*uevent_param
)
495 struct ltt_channel
*channel
= channel_file
->private_data
;
496 struct ltt_event
*event
;
497 struct lttng_kernel_event event_param
;
499 struct file
*event_file
;
501 if (copy_from_user(&event_param
, uevent_param
, sizeof(event_param
)))
503 event_param
.name
[LTTNG_SYM_NAME_LEN
- 1] = '\0';
504 switch (event_param
.instrumentation
) {
505 case LTTNG_KERNEL_KRETPROBE
:
506 event_param
.u
.kretprobe
.symbol_name
[LTTNG_SYM_NAME_LEN
- 1] = '\0';
508 case LTTNG_KERNEL_KPROBE
:
509 event_param
.u
.kprobe
.symbol_name
[LTTNG_SYM_NAME_LEN
- 1] = '\0';
511 case LTTNG_KERNEL_FUNCTION
:
512 event_param
.u
.ftrace
.symbol_name
[LTTNG_SYM_NAME_LEN
- 1] = '\0';
517 switch (event_param
.instrumentation
) {
519 event_fd
= get_unused_fd();
524 event_file
= anon_inode_getfile("[lttng_event]",
527 if (IS_ERR(event_file
)) {
528 ret
= PTR_ERR(event_file
);
532 * We tolerate no failure path after event creation. It
533 * will stay invariant for the rest of the session.
535 event
= ltt_event_create(channel
, &event_param
, NULL
);
540 event_file
->private_data
= event
;
541 fd_install(event_fd
, event_file
);
542 /* The event holds a reference on the channel */
543 atomic_long_inc(&channel_file
->f_count
);
545 case LTTNG_KERNEL_SYSCALLS
:
546 ret
= lttng_syscalls_register(channel
, NULL
);
557 put_unused_fd(event_fd
);
563 * lttng_channel_ioctl - lttng syscall through ioctl
569 * This ioctl implements lttng commands:
570 * LTTNG_KERNEL_STREAM
571 * Returns an event stream file descriptor or failure.
572 * (typically, one event stream records events from one CPU)
574 * Returns an event file descriptor or failure.
575 * LTTNG_KERNEL_CONTEXT
576 * Prepend a context field to each event in the channel
577 * LTTNG_KERNEL_ENABLE
578 * Enable recording for events in this channel (weak enable)
579 * LTTNG_KERNEL_DISABLE
580 * Disable recording for events in this channel (strong disable)
582 * Channel and event file descriptors also hold a reference on the session.
585 long lttng_channel_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
587 struct ltt_channel
*channel
= file
->private_data
;
590 case LTTNG_KERNEL_STREAM
:
591 return lttng_abi_open_stream(file
);
592 case LTTNG_KERNEL_EVENT
:
593 return lttng_abi_create_event(file
, (struct lttng_kernel_event __user
*) arg
);
594 case LTTNG_KERNEL_CONTEXT
:
595 return lttng_abi_add_context(file
,
596 (struct lttng_kernel_context __user
*) arg
,
597 &channel
->ctx
, channel
->session
);
598 case LTTNG_KERNEL_ENABLE
:
599 return ltt_channel_enable(channel
);
600 case LTTNG_KERNEL_DISABLE
:
601 return ltt_channel_disable(channel
);
608 * lttng_metadata_ioctl - lttng syscall through ioctl
614 * This ioctl implements lttng commands:
615 * LTTNG_KERNEL_STREAM
616 * Returns an event stream file descriptor or failure.
618 * Channel and event file descriptors also hold a reference on the session.
621 long lttng_metadata_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
624 case LTTNG_KERNEL_STREAM
:
625 return lttng_abi_open_stream(file
);
632 * lttng_channel_poll - lttng stream addition/removal monitoring
637 unsigned int lttng_channel_poll(struct file
*file
, poll_table
*wait
)
639 struct ltt_channel
*channel
= file
->private_data
;
640 unsigned int mask
= 0;
642 if (file
->f_mode
& FMODE_READ
) {
643 poll_wait_set_exclusive(wait
);
644 poll_wait(file
, channel
->ops
->get_hp_wait_queue(channel
->chan
),
647 if (channel
->ops
->is_disabled(channel
->chan
))
649 if (channel
->ops
->is_finalized(channel
->chan
))
651 if (channel
->ops
->buffer_has_read_closed_stream(channel
->chan
))
652 return POLLIN
| POLLRDNORM
;
660 int lttng_channel_release(struct inode
*inode
, struct file
*file
)
662 struct ltt_channel
*channel
= file
->private_data
;
665 fput(channel
->session
->file
);
669 static const struct file_operations lttng_channel_fops
= {
670 .owner
= THIS_MODULE
,
671 .release
= lttng_channel_release
,
672 .poll
= lttng_channel_poll
,
673 .unlocked_ioctl
= lttng_channel_ioctl
,
675 .compat_ioctl
= lttng_channel_ioctl
,
679 static const struct file_operations lttng_metadata_fops
= {
680 .owner
= THIS_MODULE
,
681 .release
= lttng_channel_release
,
682 .unlocked_ioctl
= lttng_metadata_ioctl
,
684 .compat_ioctl
= lttng_metadata_ioctl
,
689 * lttng_event_ioctl - lttng syscall through ioctl
695 * This ioctl implements lttng commands:
696 * LTTNG_KERNEL_CONTEXT
697 * Prepend a context field to each record of this event
698 * LTTNG_KERNEL_ENABLE
699 * Enable recording for this event (weak enable)
700 * LTTNG_KERNEL_DISABLE
701 * Disable recording for this event (strong disable)
704 long lttng_event_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
706 struct ltt_event
*event
= file
->private_data
;
709 case LTTNG_KERNEL_CONTEXT
:
710 return lttng_abi_add_context(file
,
711 (struct lttng_kernel_context __user
*) arg
,
712 &event
->ctx
, event
->chan
->session
);
713 case LTTNG_KERNEL_ENABLE
:
714 return ltt_event_enable(event
);
715 case LTTNG_KERNEL_DISABLE
:
716 return ltt_event_disable(event
);
723 int lttng_event_release(struct inode
*inode
, struct file
*file
)
725 struct ltt_event
*event
= file
->private_data
;
728 fput(event
->chan
->file
);
732 /* TODO: filter control ioctl */
733 static const struct file_operations lttng_event_fops
= {
734 .owner
= THIS_MODULE
,
735 .release
= lttng_event_release
,
736 .unlocked_ioctl
= lttng_event_ioctl
,
738 .compat_ioctl
= lttng_event_ioctl
,
742 int __init
ltt_debugfs_abi_init(void)
746 wrapper_vmalloc_sync_all();
747 lttng_dentry
= debugfs_create_file("lttng", S_IWUSR
, NULL
, NULL
,
749 if (IS_ERR(lttng_dentry
) || !lttng_dentry
) {
750 printk(KERN_ERR
"Error creating LTTng control file\n");
758 void __exit
ltt_debugfs_abi_exit(void)
760 debugfs_remove(lttng_dentry
);