6 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; only
11 * version 2.1 of the License.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Mimic system calls for:
24 * - session creation, returns a file descriptor or failure.
25 * - channel creation, returns a file descriptor or failure.
26 * - Operates on a session file descriptor
27 * - Takes all channel options as parameters.
28 * - stream get, returns a file descriptor or failure.
29 * - Operates on a channel file descriptor.
30 * - stream notifier get, returns a file descriptor or failure.
31 * - Operates on a channel file descriptor.
32 * - event creation, returns a file descriptor or failure.
33 * - Operates on a channel file descriptor
34 * - Takes an event name as parameter
35 * - Takes an instrumentation source as parameter
36 * - e.g. tracepoints, dynamic_probes...
37 * - Takes instrumentation source specific arguments.
40 #include <linux/module.h>
41 #include <linux/proc_fs.h>
42 #include <linux/anon_inodes.h>
43 #include <linux/file.h>
44 #include <linux/uaccess.h>
45 #include <linux/slab.h>
46 #include <linux/err.h>
47 #include "wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */
48 #include "wrapper/ringbuffer/vfs.h"
49 #include "wrapper/ringbuffer/backend.h"
50 #include "wrapper/ringbuffer/frontend.h"
51 #include "wrapper/poll.h"
52 #include "lttng-abi.h"
53 #include "lttng-abi-old.h"
54 #include "lttng-events.h"
55 #include "lttng-tracer.h"
56 #include "lib/ringbuffer/frontend_types.h"
59 * This is LTTng's own personal way to create a system call as an external
60 * module. We use ioctl() on /proc/lttng.
63 static struct proc_dir_entry
*lttng_proc_dentry
;
64 static const struct file_operations lttng_fops
;
65 static const struct file_operations lttng_session_fops
;
66 static const struct file_operations lttng_channel_fops
;
67 static const struct file_operations lttng_metadata_fops
;
68 static const struct file_operations lttng_event_fops
;
69 static struct file_operations lttng_stream_ring_buffer_file_operations
;
72 * Teardown management: opened file descriptors keep a refcount on the module,
73 * so it can only exit when all file descriptors are closed.
77 int lttng_abi_create_session(void)
79 struct lttng_session
*session
;
80 struct file
*session_file
;
83 session
= lttng_session_create();
86 session_fd
= get_unused_fd();
91 session_file
= anon_inode_getfile("[lttng_session]",
94 if (IS_ERR(session_file
)) {
95 ret
= PTR_ERR(session_file
);
98 session
->file
= session_file
;
99 fd_install(session_fd
, session_file
);
103 put_unused_fd(session_fd
);
105 lttng_session_destroy(session
);
110 int lttng_abi_tracepoint_list(void)
112 struct file
*tracepoint_list_file
;
115 file_fd
= get_unused_fd();
121 tracepoint_list_file
= anon_inode_getfile("[lttng_tracepoint_list]",
122 <tng_tracepoint_list_fops
,
124 if (IS_ERR(tracepoint_list_file
)) {
125 ret
= PTR_ERR(tracepoint_list_file
);
128 ret
= lttng_tracepoint_list_fops
.open(NULL
, tracepoint_list_file
);
131 fd_install(file_fd
, tracepoint_list_file
);
139 fput(tracepoint_list_file
);
141 put_unused_fd(file_fd
);
147 void lttng_abi_tracer_version(struct lttng_kernel_tracer_version
*v
)
149 v
->major
= LTTNG_MODULES_MAJOR_VERSION
;
150 v
->minor
= LTTNG_MODULES_MINOR_VERSION
;
151 v
->patchlevel
= LTTNG_MODULES_PATCHLEVEL_VERSION
;
155 long lttng_abi_add_context(struct file
*file
,
156 struct lttng_kernel_context
*context_param
,
157 struct lttng_ctx
**ctx
, struct lttng_session
*session
)
160 if (session
->been_active
)
163 switch (context_param
->ctx
) {
164 case LTTNG_KERNEL_CONTEXT_PID
:
165 return lttng_add_pid_to_ctx(ctx
);
166 case LTTNG_KERNEL_CONTEXT_PRIO
:
167 return lttng_add_prio_to_ctx(ctx
);
168 case LTTNG_KERNEL_CONTEXT_NICE
:
169 return lttng_add_nice_to_ctx(ctx
);
170 case LTTNG_KERNEL_CONTEXT_VPID
:
171 return lttng_add_vpid_to_ctx(ctx
);
172 case LTTNG_KERNEL_CONTEXT_TID
:
173 return lttng_add_tid_to_ctx(ctx
);
174 case LTTNG_KERNEL_CONTEXT_VTID
:
175 return lttng_add_vtid_to_ctx(ctx
);
176 case LTTNG_KERNEL_CONTEXT_PPID
:
177 return lttng_add_ppid_to_ctx(ctx
);
178 case LTTNG_KERNEL_CONTEXT_VPPID
:
179 return lttng_add_vppid_to_ctx(ctx
);
180 case LTTNG_KERNEL_CONTEXT_PERF_COUNTER
:
181 context_param
->u
.perf_counter
.name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
182 return lttng_add_perf_counter_to_ctx(context_param
->u
.perf_counter
.type
,
183 context_param
->u
.perf_counter
.config
,
184 context_param
->u
.perf_counter
.name
,
186 case LTTNG_KERNEL_CONTEXT_PROCNAME
:
187 return lttng_add_procname_to_ctx(ctx
);
188 case LTTNG_KERNEL_CONTEXT_HOSTNAME
:
189 return lttng_add_hostname_to_ctx(ctx
);
196 * lttng_ioctl - lttng syscall through ioctl
202 * This ioctl implements lttng commands:
203 * LTTNG_KERNEL_SESSION
204 * Returns a LTTng trace session file descriptor
205 * LTTNG_KERNEL_TRACER_VERSION
206 * Returns the LTTng kernel tracer version
207 * LTTNG_KERNEL_TRACEPOINT_LIST
208 * Returns a file descriptor listing available tracepoints
209 * LTTNG_KERNEL_WAIT_QUIESCENT
210 * Returns after all previously running probes have completed
212 * The returned session will be deleted when its file descriptor is closed.
215 long lttng_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
218 case LTTNG_KERNEL_OLD_SESSION
:
219 case LTTNG_KERNEL_SESSION
:
220 return lttng_abi_create_session();
221 case LTTNG_KERNEL_OLD_TRACER_VERSION
:
223 struct lttng_kernel_tracer_version v
;
224 struct lttng_kernel_old_tracer_version oldv
;
225 struct lttng_kernel_old_tracer_version
*uversion
=
226 (struct lttng_kernel_old_tracer_version __user
*) arg
;
228 lttng_abi_tracer_version(&v
);
229 oldv
.major
= v
.major
;
230 oldv
.minor
= v
.minor
;
231 oldv
.patchlevel
= v
.patchlevel
;
233 if (copy_to_user(uversion
, &oldv
, sizeof(oldv
)))
237 case LTTNG_KERNEL_TRACER_VERSION
:
239 struct lttng_kernel_tracer_version version
;
240 struct lttng_kernel_tracer_version
*uversion
=
241 (struct lttng_kernel_tracer_version __user
*) arg
;
243 lttng_abi_tracer_version(&version
);
245 if (copy_to_user(uversion
, &version
, sizeof(version
)))
249 case LTTNG_KERNEL_OLD_TRACEPOINT_LIST
:
250 case LTTNG_KERNEL_TRACEPOINT_LIST
:
251 return lttng_abi_tracepoint_list();
252 case LTTNG_KERNEL_OLD_WAIT_QUIESCENT
:
253 case LTTNG_KERNEL_WAIT_QUIESCENT
:
256 case LTTNG_KERNEL_OLD_CALIBRATE
:
258 struct lttng_kernel_old_calibrate __user
*ucalibrate
=
259 (struct lttng_kernel_old_calibrate __user
*) arg
;
260 struct lttng_kernel_old_calibrate old_calibrate
;
261 struct lttng_kernel_calibrate calibrate
;
264 if (copy_from_user(&old_calibrate
, ucalibrate
, sizeof(old_calibrate
)))
266 calibrate
.type
= old_calibrate
.type
;
267 ret
= lttng_calibrate(&calibrate
);
268 if (copy_to_user(ucalibrate
, &old_calibrate
, sizeof(old_calibrate
)))
272 case LTTNG_KERNEL_CALIBRATE
:
274 struct lttng_kernel_calibrate __user
*ucalibrate
=
275 (struct lttng_kernel_calibrate __user
*) arg
;
276 struct lttng_kernel_calibrate calibrate
;
279 if (copy_from_user(&calibrate
, ucalibrate
, sizeof(calibrate
)))
281 ret
= lttng_calibrate(&calibrate
);
282 if (copy_to_user(ucalibrate
, &calibrate
, sizeof(calibrate
)))
291 static const struct file_operations lttng_fops
= {
292 .owner
= THIS_MODULE
,
293 .unlocked_ioctl
= lttng_ioctl
,
295 .compat_ioctl
= lttng_ioctl
,
300 int lttng_abi_create_channel(struct file
*session_file
,
301 struct lttng_kernel_channel
*chan_param
,
302 enum channel_type channel_type
)
304 struct lttng_session
*session
= session_file
->private_data
;
305 const struct file_operations
*fops
= NULL
;
306 const char *transport_name
;
307 struct lttng_channel
*chan
;
308 struct file
*chan_file
;
312 chan_fd
= get_unused_fd();
317 switch (channel_type
) {
318 case PER_CPU_CHANNEL
:
319 fops
= <tng_channel_fops
;
321 case METADATA_CHANNEL
:
322 fops
= <tng_metadata_fops
;
326 chan_file
= anon_inode_getfile("[lttng_channel]",
329 if (IS_ERR(chan_file
)) {
330 ret
= PTR_ERR(chan_file
);
333 switch (channel_type
) {
334 case PER_CPU_CHANNEL
:
335 if (chan_param
->output
== LTTNG_KERNEL_SPLICE
) {
336 transport_name
= chan_param
->overwrite
?
337 "relay-overwrite" : "relay-discard";
338 } else if (chan_param
->output
== LTTNG_KERNEL_MMAP
) {
339 transport_name
= chan_param
->overwrite
?
340 "relay-overwrite-mmap" : "relay-discard-mmap";
345 case METADATA_CHANNEL
:
346 if (chan_param
->output
== LTTNG_KERNEL_SPLICE
)
347 transport_name
= "relay-metadata";
348 else if (chan_param
->output
== LTTNG_KERNEL_MMAP
)
349 transport_name
= "relay-metadata-mmap";
354 transport_name
= "<unknown>";
358 * We tolerate no failure path after channel creation. It will stay
359 * invariant for the rest of the session.
361 chan
= lttng_channel_create(session
, transport_name
, NULL
,
362 chan_param
->subbuf_size
,
363 chan_param
->num_subbuf
,
364 chan_param
->switch_timer_interval
,
365 chan_param
->read_timer_interval
,
371 chan
->file
= chan_file
;
372 chan_file
->private_data
= chan
;
373 fd_install(chan_fd
, chan_file
);
374 atomic_long_inc(&session_file
->f_count
);
381 put_unused_fd(chan_fd
);
387 * lttng_session_ioctl - lttng session fd ioctl
393 * This ioctl implements lttng commands:
394 * LTTNG_KERNEL_CHANNEL
395 * Returns a LTTng channel file descriptor
396 * LTTNG_KERNEL_ENABLE
397 * Enables tracing for a session (weak enable)
398 * LTTNG_KERNEL_DISABLE
399 * Disables tracing for a session (strong disable)
400 * LTTNG_KERNEL_METADATA
401 * Returns a LTTng metadata file descriptor
403 * The returned channel will be deleted when its file descriptor is closed.
406 long lttng_session_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
408 struct lttng_session
*session
= file
->private_data
;
411 case LTTNG_KERNEL_OLD_CHANNEL
:
413 struct lttng_kernel_channel chan_param
;
414 struct lttng_kernel_old_channel old_chan_param
;
416 if (copy_from_user(&old_chan_param
,
417 (struct lttng_kernel_old_channel __user
*) arg
,
418 sizeof(struct lttng_kernel_old_channel
)))
420 chan_param
.overwrite
= old_chan_param
.overwrite
;
421 chan_param
.subbuf_size
= old_chan_param
.subbuf_size
;
422 chan_param
.num_subbuf
= old_chan_param
.num_subbuf
;
423 chan_param
.switch_timer_interval
= old_chan_param
.switch_timer_interval
;
424 chan_param
.read_timer_interval
= old_chan_param
.read_timer_interval
;
425 chan_param
.output
= old_chan_param
.output
;
427 return lttng_abi_create_channel(file
, &chan_param
,
430 case LTTNG_KERNEL_CHANNEL
:
432 struct lttng_kernel_channel chan_param
;
434 if (copy_from_user(&chan_param
,
435 (struct lttng_kernel_channel __user
*) arg
,
436 sizeof(struct lttng_kernel_channel
)))
438 return lttng_abi_create_channel(file
, &chan_param
,
441 case LTTNG_KERNEL_OLD_SESSION_START
:
442 case LTTNG_KERNEL_OLD_ENABLE
:
443 case LTTNG_KERNEL_SESSION_START
:
444 case LTTNG_KERNEL_ENABLE
:
445 return lttng_session_enable(session
);
446 case LTTNG_KERNEL_OLD_SESSION_STOP
:
447 case LTTNG_KERNEL_OLD_DISABLE
:
448 case LTTNG_KERNEL_SESSION_STOP
:
449 case LTTNG_KERNEL_DISABLE
:
450 return lttng_session_disable(session
);
451 case LTTNG_KERNEL_OLD_METADATA
:
453 struct lttng_kernel_channel chan_param
;
454 struct lttng_kernel_old_channel old_chan_param
;
456 if (copy_from_user(&old_chan_param
,
457 (struct lttng_kernel_old_channel __user
*) arg
,
458 sizeof(struct lttng_kernel_old_channel
)))
460 chan_param
.overwrite
= old_chan_param
.overwrite
;
461 chan_param
.subbuf_size
= old_chan_param
.subbuf_size
;
462 chan_param
.num_subbuf
= old_chan_param
.num_subbuf
;
463 chan_param
.switch_timer_interval
= old_chan_param
.switch_timer_interval
;
464 chan_param
.read_timer_interval
= old_chan_param
.read_timer_interval
;
465 chan_param
.output
= old_chan_param
.output
;
467 return lttng_abi_create_channel(file
, &chan_param
,
470 case LTTNG_KERNEL_METADATA
:
472 struct lttng_kernel_channel chan_param
;
474 if (copy_from_user(&chan_param
,
475 (struct lttng_kernel_channel __user
*) arg
,
476 sizeof(struct lttng_kernel_channel
)))
478 return lttng_abi_create_channel(file
, &chan_param
,
487 * Called when the last file reference is dropped.
489 * Big fat note: channels and events are invariant for the whole session after
490 * their creation. So this session destruction also destroys all channel and
491 * event structures specific to this session (they are not destroyed when their
492 * individual file is released).
495 int lttng_session_release(struct inode
*inode
, struct file
*file
)
497 struct lttng_session
*session
= file
->private_data
;
500 lttng_session_destroy(session
);
504 static const struct file_operations lttng_session_fops
= {
505 .owner
= THIS_MODULE
,
506 .release
= lttng_session_release
,
507 .unlocked_ioctl
= lttng_session_ioctl
,
509 .compat_ioctl
= lttng_session_ioctl
,
514 * lttng_metadata_ring_buffer_poll - LTTng ring buffer poll file operation
518 * Handles the poll operations for the metadata channels.
521 unsigned int lttng_metadata_ring_buffer_poll(struct file
*filp
,
524 struct lttng_metadata_stream
*stream
= filp
->private_data
;
525 struct lib_ring_buffer
*buf
= stream
->priv
;
527 unsigned int mask
= 0;
529 if (filp
->f_mode
& FMODE_READ
) {
530 poll_wait_set_exclusive(wait
);
531 poll_wait(filp
, &stream
->read_wait
, wait
);
533 finalized
= stream
->finalized
;
536 * lib_ring_buffer_is_finalized() contains a smp_rmb()
537 * ordering finalized load before offsets loads.
539 WARN_ON(atomic_long_read(&buf
->active_readers
) != 1);
544 if (stream
->metadata_cache
->metadata_written
>
545 stream
->metadata_out
)
553 void lttng_metadata_ring_buffer_ioctl_put_next_subbuf(struct file
*filp
,
554 unsigned int cmd
, unsigned long arg
)
556 struct lttng_metadata_stream
*stream
= filp
->private_data
;
558 stream
->metadata_out
= stream
->metadata_in
;
562 long lttng_metadata_ring_buffer_ioctl(struct file
*filp
,
563 unsigned int cmd
, unsigned long arg
)
566 struct lttng_metadata_stream
*stream
= filp
->private_data
;
567 struct lib_ring_buffer
*buf
= stream
->priv
;
570 case RING_BUFFER_GET_NEXT_SUBBUF
:
572 struct lttng_metadata_stream
*stream
= filp
->private_data
;
573 struct lib_ring_buffer
*buf
= stream
->priv
;
574 struct channel
*chan
= buf
->backend
.chan
;
576 ret
= lttng_metadata_output_channel(stream
, chan
);
578 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
);
584 case RING_BUFFER_GET_SUBBUF
:
587 * Random access is not allowed for metadata channel.
591 case RING_BUFFER_FLUSH
:
593 struct lttng_metadata_stream
*stream
= filp
->private_data
;
594 struct lib_ring_buffer
*buf
= stream
->priv
;
595 struct channel
*chan
= buf
->backend
.chan
;
598 * Before doing the actual ring buffer flush, write up to one
599 * packet of metadata in the ring buffer.
601 ret
= lttng_metadata_output_channel(stream
, chan
);
609 /* PUT_SUBBUF is the one from lib ring buffer, unmodified. */
611 /* Performing lib ring buffer ioctl after our own. */
612 ret
= lib_ring_buffer_ioctl(filp
, cmd
, arg
, buf
);
617 case RING_BUFFER_PUT_NEXT_SUBBUF
:
619 lttng_metadata_ring_buffer_ioctl_put_next_subbuf(filp
,
632 long lttng_metadata_ring_buffer_compat_ioctl(struct file
*filp
,
633 unsigned int cmd
, unsigned long arg
)
636 struct lttng_metadata_stream
*stream
= filp
->private_data
;
637 struct lib_ring_buffer
*buf
= stream
->priv
;
640 case RING_BUFFER_GET_NEXT_SUBBUF
:
642 struct lttng_metadata_stream
*stream
= filp
->private_data
;
643 struct lib_ring_buffer
*buf
= stream
->priv
;
644 struct channel
*chan
= buf
->backend
.chan
;
646 ret
= lttng_metadata_output_channel(stream
, chan
);
648 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
);
654 case RING_BUFFER_GET_SUBBUF
:
657 * Random access is not allowed for metadata channel.
664 /* PUT_SUBBUF is the one from lib ring buffer, unmodified. */
666 /* Performing lib ring buffer ioctl after our own. */
667 ret
= lib_ring_buffer_compat_ioctl(filp
, cmd
, arg
, buf
);
672 case RING_BUFFER_PUT_NEXT_SUBBUF
:
674 lttng_metadata_ring_buffer_ioctl_put_next_subbuf(filp
,
687 * This is not used by anonymous file descriptors. This code is left
688 * there if we ever want to implement an inode with open() operation.
691 int lttng_metadata_ring_buffer_open(struct inode
*inode
, struct file
*file
)
693 struct lttng_metadata_stream
*stream
= inode
->i_private
;
694 struct lib_ring_buffer
*buf
= stream
->priv
;
696 file
->private_data
= buf
;
698 * Since life-time of metadata cache differs from that of
699 * session, we need to keep our own reference on the transport.
701 if (!try_module_get(stream
->transport
->owner
)) {
702 printk(KERN_WARNING
"LTT : Can't lock transport module.\n");
705 return lib_ring_buffer_open(inode
, file
, buf
);
709 int lttng_metadata_ring_buffer_release(struct inode
*inode
, struct file
*file
)
711 struct lttng_metadata_stream
*stream
= file
->private_data
;
712 struct lib_ring_buffer
*buf
= stream
->priv
;
714 kref_put(&stream
->metadata_cache
->refcount
, metadata_cache_destroy
);
715 module_put(stream
->transport
->owner
);
716 return lib_ring_buffer_release(inode
, file
, buf
);
720 ssize_t
lttng_metadata_ring_buffer_splice_read(struct file
*in
, loff_t
*ppos
,
721 struct pipe_inode_info
*pipe
, size_t len
,
724 struct lttng_metadata_stream
*stream
= in
->private_data
;
725 struct lib_ring_buffer
*buf
= stream
->priv
;
727 return lib_ring_buffer_splice_read(in
, ppos
, pipe
, len
,
732 int lttng_metadata_ring_buffer_mmap(struct file
*filp
,
733 struct vm_area_struct
*vma
)
735 struct lttng_metadata_stream
*stream
= filp
->private_data
;
736 struct lib_ring_buffer
*buf
= stream
->priv
;
738 return lib_ring_buffer_mmap(filp
, vma
, buf
);
742 const struct file_operations lttng_metadata_ring_buffer_file_operations
= {
743 .owner
= THIS_MODULE
,
744 .open
= lttng_metadata_ring_buffer_open
,
745 .release
= lttng_metadata_ring_buffer_release
,
746 .poll
= lttng_metadata_ring_buffer_poll
,
747 .splice_read
= lttng_metadata_ring_buffer_splice_read
,
748 .mmap
= lttng_metadata_ring_buffer_mmap
,
749 .unlocked_ioctl
= lttng_metadata_ring_buffer_ioctl
,
750 .llseek
= vfs_lib_ring_buffer_no_llseek
,
752 .compat_ioctl
= lttng_metadata_ring_buffer_compat_ioctl
,
757 int lttng_abi_create_stream_fd(struct file
*channel_file
, void *stream_priv
,
758 const struct file_operations
*fops
)
761 struct file
*stream_file
;
763 stream_fd
= get_unused_fd();
768 stream_file
= anon_inode_getfile("[lttng_stream]", fops
,
769 stream_priv
, O_RDWR
);
770 if (IS_ERR(stream_file
)) {
771 ret
= PTR_ERR(stream_file
);
775 * OPEN_FMODE, called within anon_inode_getfile/alloc_file, don't honor
776 * FMODE_LSEEK, FMODE_PREAD nor FMODE_PWRITE. We need to read from this
777 * file descriptor, so we set FMODE_PREAD here.
779 stream_file
->f_mode
|= FMODE_PREAD
;
780 fd_install(stream_fd
, stream_file
);
782 * The stream holds a reference to the channel within the generic ring
783 * buffer library, so no need to hold a refcount on the channel and
784 * session files here.
789 put_unused_fd(stream_fd
);
795 int lttng_abi_open_stream(struct file
*channel_file
)
797 struct lttng_channel
*channel
= channel_file
->private_data
;
798 struct lib_ring_buffer
*buf
;
802 buf
= channel
->ops
->buffer_read_open(channel
->chan
);
807 ret
= lttng_abi_create_stream_fd(channel_file
, stream_priv
,
808 <tng_stream_ring_buffer_file_operations
);
815 channel
->ops
->buffer_read_close(buf
);
820 int lttng_abi_open_metadata_stream(struct file
*channel_file
)
822 struct lttng_channel
*channel
= channel_file
->private_data
;
823 struct lttng_session
*session
= channel
->session
;
824 struct lib_ring_buffer
*buf
;
826 struct lttng_metadata_stream
*metadata_stream
;
829 buf
= channel
->ops
->buffer_read_open(channel
->chan
);
833 metadata_stream
= kzalloc(sizeof(struct lttng_metadata_stream
),
835 if (!metadata_stream
) {
839 metadata_stream
->metadata_cache
= session
->metadata_cache
;
840 init_waitqueue_head(&metadata_stream
->read_wait
);
841 metadata_stream
->priv
= buf
;
842 stream_priv
= metadata_stream
;
843 metadata_stream
->transport
= channel
->transport
;
844 mutex_init(&metadata_stream
->lock
);
847 * Since life-time of metadata cache differs from that of
848 * session, we need to keep our own reference on the transport.
850 if (!try_module_get(metadata_stream
->transport
->owner
)) {
851 printk(KERN_WARNING
"LTT : Can't lock transport module.\n");
856 ret
= lttng_abi_create_stream_fd(channel_file
, stream_priv
,
857 <tng_metadata_ring_buffer_file_operations
);
861 kref_get(&session
->metadata_cache
->refcount
);
862 list_add(&metadata_stream
->list
,
863 &session
->metadata_cache
->metadata_stream
);
867 module_put(metadata_stream
->transport
->owner
);
869 kfree(metadata_stream
);
871 channel
->ops
->buffer_read_close(buf
);
876 int lttng_abi_create_event(struct file
*channel_file
,
877 struct lttng_kernel_event
*event_param
)
879 struct lttng_channel
*channel
= channel_file
->private_data
;
880 struct lttng_event
*event
;
882 struct file
*event_file
;
884 event_param
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
885 switch (event_param
->instrumentation
) {
886 case LTTNG_KERNEL_KRETPROBE
:
887 event_param
->u
.kretprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
889 case LTTNG_KERNEL_KPROBE
:
890 event_param
->u
.kprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
892 case LTTNG_KERNEL_FUNCTION
:
893 event_param
->u
.ftrace
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
898 switch (event_param
->instrumentation
) {
900 event_fd
= get_unused_fd();
905 event_file
= anon_inode_getfile("[lttng_event]",
908 if (IS_ERR(event_file
)) {
909 ret
= PTR_ERR(event_file
);
913 * We tolerate no failure path after event creation. It
914 * will stay invariant for the rest of the session.
916 event
= lttng_event_create(channel
, event_param
, NULL
, NULL
);
917 WARN_ON_ONCE(!event
);
919 ret
= PTR_ERR(event
);
922 event_file
->private_data
= event
;
923 fd_install(event_fd
, event_file
);
924 /* The event holds a reference on the channel */
925 atomic_long_inc(&channel_file
->f_count
);
927 case LTTNG_KERNEL_SYSCALL
:
928 ret
= lttng_syscalls_register(channel
, NULL
);
932 if (event_param
->u
.syscall
.disable
) {
933 ret
= lttng_syscall_filter_disable(channel
,
934 event_param
->name
[0] == '\0' ?
935 NULL
: event_param
->name
);
939 ret
= lttng_syscall_filter_enable(channel
,
940 event_param
->name
[0] == '\0' ?
941 NULL
: event_param
->name
);
952 put_unused_fd(event_fd
);
958 * lttng_channel_ioctl - lttng syscall through ioctl
964 * This ioctl implements lttng commands:
965 * LTTNG_KERNEL_STREAM
966 * Returns an event stream file descriptor or failure.
967 * (typically, one event stream records events from one CPU)
969 * Returns an event file descriptor or failure.
970 * LTTNG_KERNEL_CONTEXT
971 * Prepend a context field to each event in the channel
972 * LTTNG_KERNEL_ENABLE
973 * Enable recording for events in this channel (weak enable)
974 * LTTNG_KERNEL_DISABLE
975 * Disable recording for events in this channel (strong disable)
977 * Channel and event file descriptors also hold a reference on the session.
980 long lttng_channel_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
982 struct lttng_channel
*channel
= file
->private_data
;
985 case LTTNG_KERNEL_OLD_STREAM
:
986 case LTTNG_KERNEL_STREAM
:
987 return lttng_abi_open_stream(file
);
988 case LTTNG_KERNEL_OLD_EVENT
:
990 struct lttng_kernel_event
*uevent_param
;
991 struct lttng_kernel_old_event
*old_uevent_param
;
994 uevent_param
= kmalloc(sizeof(struct lttng_kernel_event
),
1000 old_uevent_param
= kmalloc(
1001 sizeof(struct lttng_kernel_old_event
),
1003 if (!old_uevent_param
) {
1005 goto old_event_error_free_param
;
1007 if (copy_from_user(old_uevent_param
,
1008 (struct lttng_kernel_old_event __user
*) arg
,
1009 sizeof(struct lttng_kernel_old_event
))) {
1011 goto old_event_error_free_old_param
;
1014 memcpy(uevent_param
->name
, old_uevent_param
->name
,
1015 sizeof(uevent_param
->name
));
1016 uevent_param
->instrumentation
=
1017 old_uevent_param
->instrumentation
;
1019 switch (old_uevent_param
->instrumentation
) {
1020 case LTTNG_KERNEL_KPROBE
:
1021 uevent_param
->u
.kprobe
.addr
=
1022 old_uevent_param
->u
.kprobe
.addr
;
1023 uevent_param
->u
.kprobe
.offset
=
1024 old_uevent_param
->u
.kprobe
.offset
;
1025 memcpy(uevent_param
->u
.kprobe
.symbol_name
,
1026 old_uevent_param
->u
.kprobe
.symbol_name
,
1027 sizeof(uevent_param
->u
.kprobe
.symbol_name
));
1029 case LTTNG_KERNEL_KRETPROBE
:
1030 uevent_param
->u
.kretprobe
.addr
=
1031 old_uevent_param
->u
.kretprobe
.addr
;
1032 uevent_param
->u
.kretprobe
.offset
=
1033 old_uevent_param
->u
.kretprobe
.offset
;
1034 memcpy(uevent_param
->u
.kretprobe
.symbol_name
,
1035 old_uevent_param
->u
.kretprobe
.symbol_name
,
1036 sizeof(uevent_param
->u
.kretprobe
.symbol_name
));
1038 case LTTNG_KERNEL_FUNCTION
:
1039 memcpy(uevent_param
->u
.ftrace
.symbol_name
,
1040 old_uevent_param
->u
.ftrace
.symbol_name
,
1041 sizeof(uevent_param
->u
.ftrace
.symbol_name
));
1046 ret
= lttng_abi_create_event(file
, uevent_param
);
1048 old_event_error_free_old_param
:
1049 kfree(old_uevent_param
);
1050 old_event_error_free_param
:
1051 kfree(uevent_param
);
1055 case LTTNG_KERNEL_EVENT
:
1057 struct lttng_kernel_event uevent_param
;
1059 if (copy_from_user(&uevent_param
,
1060 (struct lttng_kernel_event __user
*) arg
,
1061 sizeof(uevent_param
)))
1063 return lttng_abi_create_event(file
, &uevent_param
);
1065 case LTTNG_KERNEL_OLD_CONTEXT
:
1067 struct lttng_kernel_context
*ucontext_param
;
1068 struct lttng_kernel_old_context
*old_ucontext_param
;
1071 ucontext_param
= kmalloc(sizeof(struct lttng_kernel_context
),
1073 if (!ucontext_param
) {
1077 old_ucontext_param
= kmalloc(sizeof(struct lttng_kernel_old_context
),
1079 if (!old_ucontext_param
) {
1081 goto old_ctx_error_free_param
;
1084 if (copy_from_user(old_ucontext_param
,
1085 (struct lttng_kernel_old_context __user
*) arg
,
1086 sizeof(struct lttng_kernel_old_context
))) {
1088 goto old_ctx_error_free_old_param
;
1090 ucontext_param
->ctx
= old_ucontext_param
->ctx
;
1091 memcpy(ucontext_param
->padding
, old_ucontext_param
->padding
,
1092 sizeof(ucontext_param
->padding
));
1093 /* only type that uses the union */
1094 if (old_ucontext_param
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_COUNTER
) {
1095 ucontext_param
->u
.perf_counter
.type
=
1096 old_ucontext_param
->u
.perf_counter
.type
;
1097 ucontext_param
->u
.perf_counter
.config
=
1098 old_ucontext_param
->u
.perf_counter
.config
;
1099 memcpy(ucontext_param
->u
.perf_counter
.name
,
1100 old_ucontext_param
->u
.perf_counter
.name
,
1101 sizeof(ucontext_param
->u
.perf_counter
.name
));
1104 ret
= lttng_abi_add_context(file
,
1106 &channel
->ctx
, channel
->session
);
1108 old_ctx_error_free_old_param
:
1109 kfree(old_ucontext_param
);
1110 old_ctx_error_free_param
:
1111 kfree(ucontext_param
);
1115 case LTTNG_KERNEL_CONTEXT
:
1117 struct lttng_kernel_context ucontext_param
;
1119 if (copy_from_user(&ucontext_param
,
1120 (struct lttng_kernel_context __user
*) arg
,
1121 sizeof(ucontext_param
)))
1123 return lttng_abi_add_context(file
,
1125 &channel
->ctx
, channel
->session
);
1127 case LTTNG_KERNEL_OLD_ENABLE
:
1128 case LTTNG_KERNEL_ENABLE
:
1129 return lttng_channel_enable(channel
);
1130 case LTTNG_KERNEL_OLD_DISABLE
:
1131 case LTTNG_KERNEL_DISABLE
:
1132 return lttng_channel_disable(channel
);
1134 return -ENOIOCTLCMD
;
1140 * lttng_metadata_ioctl - lttng syscall through ioctl
1146 * This ioctl implements lttng commands:
1147 * LTTNG_KERNEL_STREAM
1148 * Returns an event stream file descriptor or failure.
1150 * Channel and event file descriptors also hold a reference on the session.
1153 long lttng_metadata_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1156 case LTTNG_KERNEL_OLD_STREAM
:
1157 case LTTNG_KERNEL_STREAM
:
1158 return lttng_abi_open_metadata_stream(file
);
1160 return -ENOIOCTLCMD
;
1165 * lttng_channel_poll - lttng stream addition/removal monitoring
1170 unsigned int lttng_channel_poll(struct file
*file
, poll_table
*wait
)
1172 struct lttng_channel
*channel
= file
->private_data
;
1173 unsigned int mask
= 0;
1175 if (file
->f_mode
& FMODE_READ
) {
1176 poll_wait_set_exclusive(wait
);
1177 poll_wait(file
, channel
->ops
->get_hp_wait_queue(channel
->chan
),
1180 if (channel
->ops
->is_disabled(channel
->chan
))
1182 if (channel
->ops
->is_finalized(channel
->chan
))
1184 if (channel
->ops
->buffer_has_read_closed_stream(channel
->chan
))
1185 return POLLIN
| POLLRDNORM
;
1193 int lttng_channel_release(struct inode
*inode
, struct file
*file
)
1195 struct lttng_channel
*channel
= file
->private_data
;
1198 fput(channel
->session
->file
);
1203 int lttng_metadata_channel_release(struct inode
*inode
, struct file
*file
)
1205 struct lttng_channel
*channel
= file
->private_data
;
1208 lttng_metadata_channel_destroy(channel
);
1209 fput(channel
->session
->file
);
1215 static const struct file_operations lttng_channel_fops
= {
1216 .owner
= THIS_MODULE
,
1217 .release
= lttng_channel_release
,
1218 .poll
= lttng_channel_poll
,
1219 .unlocked_ioctl
= lttng_channel_ioctl
,
1220 #ifdef CONFIG_COMPAT
1221 .compat_ioctl
= lttng_channel_ioctl
,
1225 static const struct file_operations lttng_metadata_fops
= {
1226 .owner
= THIS_MODULE
,
1227 .release
= lttng_metadata_channel_release
,
1228 .unlocked_ioctl
= lttng_metadata_ioctl
,
1229 #ifdef CONFIG_COMPAT
1230 .compat_ioctl
= lttng_metadata_ioctl
,
1235 * lttng_event_ioctl - lttng syscall through ioctl
1241 * This ioctl implements lttng commands:
1242 * LTTNG_KERNEL_CONTEXT
1243 * Prepend a context field to each record of this event
1244 * LTTNG_KERNEL_ENABLE
1245 * Enable recording for this event (weak enable)
1246 * LTTNG_KERNEL_DISABLE
1247 * Disable recording for this event (strong disable)
1250 long lttng_event_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1252 struct lttng_event
*event
= file
->private_data
;
1255 case LTTNG_KERNEL_OLD_CONTEXT
:
1257 struct lttng_kernel_context
*ucontext_param
;
1258 struct lttng_kernel_old_context
*old_ucontext_param
;
1261 ucontext_param
= kmalloc(sizeof(struct lttng_kernel_context
),
1263 if (!ucontext_param
) {
1267 old_ucontext_param
= kmalloc(sizeof(struct lttng_kernel_old_context
),
1269 if (!old_ucontext_param
) {
1271 goto old_ctx_error_free_param
;
1274 if (copy_from_user(old_ucontext_param
,
1275 (struct lttng_kernel_old_context __user
*) arg
,
1276 sizeof(struct lttng_kernel_old_context
))) {
1278 goto old_ctx_error_free_old_param
;
1280 ucontext_param
->ctx
= old_ucontext_param
->ctx
;
1281 memcpy(ucontext_param
->padding
, old_ucontext_param
->padding
,
1282 sizeof(ucontext_param
->padding
));
1283 /* only type that uses the union */
1284 if (old_ucontext_param
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_COUNTER
) {
1285 ucontext_param
->u
.perf_counter
.type
=
1286 old_ucontext_param
->u
.perf_counter
.type
;
1287 ucontext_param
->u
.perf_counter
.config
=
1288 old_ucontext_param
->u
.perf_counter
.config
;
1289 memcpy(ucontext_param
->u
.perf_counter
.name
,
1290 old_ucontext_param
->u
.perf_counter
.name
,
1291 sizeof(ucontext_param
->u
.perf_counter
.name
));
1294 ret
= lttng_abi_add_context(file
,
1296 &event
->ctx
, event
->chan
->session
);
1298 old_ctx_error_free_old_param
:
1299 kfree(old_ucontext_param
);
1300 old_ctx_error_free_param
:
1301 kfree(ucontext_param
);
1305 case LTTNG_KERNEL_CONTEXT
:
1307 struct lttng_kernel_context ucontext_param
;
1309 if (copy_from_user(&ucontext_param
,
1310 (struct lttng_kernel_context __user
*) arg
,
1311 sizeof(ucontext_param
)))
1313 return lttng_abi_add_context(file
,
1315 &event
->ctx
, event
->chan
->session
);
1317 case LTTNG_KERNEL_OLD_ENABLE
:
1318 case LTTNG_KERNEL_ENABLE
:
1319 return lttng_event_enable(event
);
1320 case LTTNG_KERNEL_OLD_DISABLE
:
1321 case LTTNG_KERNEL_DISABLE
:
1322 return lttng_event_disable(event
);
1324 return -ENOIOCTLCMD
;
1329 int lttng_event_release(struct inode
*inode
, struct file
*file
)
1331 struct lttng_event
*event
= file
->private_data
;
1334 fput(event
->chan
->file
);
1338 /* TODO: filter control ioctl */
1339 static const struct file_operations lttng_event_fops
= {
1340 .owner
= THIS_MODULE
,
1341 .release
= lttng_event_release
,
1342 .unlocked_ioctl
= lttng_event_ioctl
,
1343 #ifdef CONFIG_COMPAT
1344 .compat_ioctl
= lttng_event_ioctl
,
1348 static int put_u64(uint64_t val
, unsigned long arg
)
1350 return put_user(val
, (uint64_t __user
*) arg
);
1353 static long lttng_stream_ring_buffer_ioctl(struct file
*filp
,
1354 unsigned int cmd
, unsigned long arg
)
1356 struct lib_ring_buffer
*buf
= filp
->private_data
;
1357 struct channel
*chan
= buf
->backend
.chan
;
1358 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1359 const struct lttng_channel_ops
*ops
= chan
->backend
.priv_ops
;
1362 if (atomic_read(&chan
->record_disabled
))
1366 case LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
:
1370 ret
= ops
->timestamp_begin(config
, buf
, &ts
);
1373 return put_u64(ts
, arg
);
1375 case LTTNG_RING_BUFFER_GET_TIMESTAMP_END
:
1379 ret
= ops
->timestamp_end(config
, buf
, &ts
);
1382 return put_u64(ts
, arg
);
1384 case LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
:
1388 ret
= ops
->events_discarded(config
, buf
, &ed
);
1391 return put_u64(ed
, arg
);
1393 case LTTNG_RING_BUFFER_GET_CONTENT_SIZE
:
1397 ret
= ops
->content_size(config
, buf
, &cs
);
1400 return put_u64(cs
, arg
);
1402 case LTTNG_RING_BUFFER_GET_PACKET_SIZE
:
1406 ret
= ops
->packet_size(config
, buf
, &ps
);
1409 return put_u64(ps
, arg
);
1411 case LTTNG_RING_BUFFER_GET_STREAM_ID
:
1415 ret
= ops
->stream_id(config
, buf
, &si
);
1418 return put_u64(si
, arg
);
1420 case LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
:
1424 ret
= ops
->current_timestamp(config
, buf
, &ts
);
1427 return put_u64(ts
, arg
);
1430 return lib_ring_buffer_file_operations
.unlocked_ioctl(filp
,
1438 #ifdef CONFIG_COMPAT
1439 static long lttng_stream_ring_buffer_compat_ioctl(struct file
*filp
,
1440 unsigned int cmd
, unsigned long arg
)
1442 struct lib_ring_buffer
*buf
= filp
->private_data
;
1443 struct channel
*chan
= buf
->backend
.chan
;
1444 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1445 const struct lttng_channel_ops
*ops
= chan
->backend
.priv_ops
;
1448 if (atomic_read(&chan
->record_disabled
))
1452 case LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN
:
1456 ret
= ops
->timestamp_begin(config
, buf
, &ts
);
1459 return put_u64(ts
, arg
);
1461 case LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END
:
1465 ret
= ops
->timestamp_end(config
, buf
, &ts
);
1468 return put_u64(ts
, arg
);
1470 case LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED
:
1474 ret
= ops
->events_discarded(config
, buf
, &ed
);
1477 return put_u64(ed
, arg
);
1479 case LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE
:
1483 ret
= ops
->content_size(config
, buf
, &cs
);
1486 return put_u64(cs
, arg
);
1488 case LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE
:
1492 ret
= ops
->packet_size(config
, buf
, &ps
);
1495 return put_u64(ps
, arg
);
1497 case LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID
:
1501 ret
= ops
->stream_id(config
, buf
, &si
);
1504 return put_u64(si
, arg
);
1506 case LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
:
1510 ret
= ops
->current_timestamp(config
, buf
, &ts
);
1513 return put_u64(ts
, arg
);
1516 return lib_ring_buffer_file_operations
.compat_ioctl(filp
,
1523 #endif /* CONFIG_COMPAT */
1525 static void lttng_stream_override_ring_buffer_fops(void)
1527 lttng_stream_ring_buffer_file_operations
.owner
= THIS_MODULE
;
1528 lttng_stream_ring_buffer_file_operations
.open
=
1529 lib_ring_buffer_file_operations
.open
;
1530 lttng_stream_ring_buffer_file_operations
.release
=
1531 lib_ring_buffer_file_operations
.release
;
1532 lttng_stream_ring_buffer_file_operations
.poll
=
1533 lib_ring_buffer_file_operations
.poll
;
1534 lttng_stream_ring_buffer_file_operations
.splice_read
=
1535 lib_ring_buffer_file_operations
.splice_read
;
1536 lttng_stream_ring_buffer_file_operations
.mmap
=
1537 lib_ring_buffer_file_operations
.mmap
;
1538 lttng_stream_ring_buffer_file_operations
.unlocked_ioctl
=
1539 lttng_stream_ring_buffer_ioctl
;
1540 lttng_stream_ring_buffer_file_operations
.llseek
=
1541 lib_ring_buffer_file_operations
.llseek
;
1542 #ifdef CONFIG_COMPAT
1543 lttng_stream_ring_buffer_file_operations
.compat_ioctl
=
1544 lttng_stream_ring_buffer_compat_ioctl
;
1548 int __init
lttng_abi_init(void)
1552 wrapper_vmalloc_sync_all();
1553 lttng_proc_dentry
= proc_create_data("lttng", S_IRUSR
| S_IWUSR
, NULL
,
1556 if (!lttng_proc_dentry
) {
1557 printk(KERN_ERR
"Error creating LTTng control file\n");
1561 lttng_stream_override_ring_buffer_fops();
1567 /* No __exit annotation because used by init error path too. */
1568 void lttng_abi_exit(void)
1570 if (lttng_proc_dentry
)
1571 remove_proc_entry("lttng", NULL
);