Fix: Always build vmscan probe
[lttng-modules.git] / lttng-abi.c
1 /*
2 * lttng-abi.c
3 *
4 * LTTng ABI
5 *
6 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
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.
12 *
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.
17 *
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
21 *
22 *
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.
38 */
39
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 <wrapper/file.h>
53 #include <wrapper/kref.h>
54 #include <lttng-abi.h>
55 #include <lttng-abi-old.h>
56 #include <lttng-events.h>
57 #include <lttng-tracer.h>
58 #include <lib/ringbuffer/frontend_types.h>
59
60 /*
61 * This is LTTng's own personal way to create a system call as an external
62 * module. We use ioctl() on /proc/lttng.
63 */
64
65 static struct proc_dir_entry *lttng_proc_dentry;
66 static const struct file_operations lttng_fops;
67 static const struct file_operations lttng_session_fops;
68 static const struct file_operations lttng_channel_fops;
69 static const struct file_operations lttng_metadata_fops;
70 static const struct file_operations lttng_event_fops;
71 static struct file_operations lttng_stream_ring_buffer_file_operations;
72
73 static int put_u64(uint64_t val, unsigned long arg);
74
75 /*
76 * Teardown management: opened file descriptors keep a refcount on the module,
77 * so it can only exit when all file descriptors are closed.
78 */
79
80 static
81 int lttng_abi_create_session(void)
82 {
83 struct lttng_session *session;
84 struct file *session_file;
85 int session_fd, ret;
86
87 session = lttng_session_create();
88 if (!session)
89 return -ENOMEM;
90 session_fd = lttng_get_unused_fd();
91 if (session_fd < 0) {
92 ret = session_fd;
93 goto fd_error;
94 }
95 session_file = anon_inode_getfile("[lttng_session]",
96 &lttng_session_fops,
97 session, O_RDWR);
98 if (IS_ERR(session_file)) {
99 ret = PTR_ERR(session_file);
100 goto file_error;
101 }
102 session->file = session_file;
103 fd_install(session_fd, session_file);
104 return session_fd;
105
106 file_error:
107 put_unused_fd(session_fd);
108 fd_error:
109 lttng_session_destroy(session);
110 return ret;
111 }
112
113 static
114 int lttng_abi_tracepoint_list(void)
115 {
116 struct file *tracepoint_list_file;
117 int file_fd, ret;
118
119 file_fd = lttng_get_unused_fd();
120 if (file_fd < 0) {
121 ret = file_fd;
122 goto fd_error;
123 }
124
125 tracepoint_list_file = anon_inode_getfile("[lttng_tracepoint_list]",
126 &lttng_tracepoint_list_fops,
127 NULL, O_RDWR);
128 if (IS_ERR(tracepoint_list_file)) {
129 ret = PTR_ERR(tracepoint_list_file);
130 goto file_error;
131 }
132 ret = lttng_tracepoint_list_fops.open(NULL, tracepoint_list_file);
133 if (ret < 0)
134 goto open_error;
135 fd_install(file_fd, tracepoint_list_file);
136 return file_fd;
137
138 open_error:
139 fput(tracepoint_list_file);
140 file_error:
141 put_unused_fd(file_fd);
142 fd_error:
143 return ret;
144 }
145
146 #ifndef CONFIG_HAVE_SYSCALL_TRACEPOINTS
147 static inline
148 int lttng_abi_syscall_list(void)
149 {
150 return -ENOSYS;
151 }
152 #else
153 static
154 int lttng_abi_syscall_list(void)
155 {
156 struct file *syscall_list_file;
157 int file_fd, ret;
158
159 file_fd = lttng_get_unused_fd();
160 if (file_fd < 0) {
161 ret = file_fd;
162 goto fd_error;
163 }
164
165 syscall_list_file = anon_inode_getfile("[lttng_syscall_list]",
166 &lttng_syscall_list_fops,
167 NULL, O_RDWR);
168 if (IS_ERR(syscall_list_file)) {
169 ret = PTR_ERR(syscall_list_file);
170 goto file_error;
171 }
172 ret = lttng_syscall_list_fops.open(NULL, syscall_list_file);
173 if (ret < 0)
174 goto open_error;
175 fd_install(file_fd, syscall_list_file);
176 return file_fd;
177
178 open_error:
179 fput(syscall_list_file);
180 file_error:
181 put_unused_fd(file_fd);
182 fd_error:
183 return ret;
184 }
185 #endif
186
187 static
188 void lttng_abi_tracer_version(struct lttng_kernel_tracer_version *v)
189 {
190 v->major = LTTNG_MODULES_MAJOR_VERSION;
191 v->minor = LTTNG_MODULES_MINOR_VERSION;
192 v->patchlevel = LTTNG_MODULES_PATCHLEVEL_VERSION;
193 }
194
195 static
196 void lttng_abi_tracer_abi_version(struct lttng_kernel_tracer_abi_version *v)
197 {
198 v->major = LTTNG_MODULES_ABI_MAJOR_VERSION;
199 v->minor = LTTNG_MODULES_ABI_MINOR_VERSION;
200 }
201
202 static
203 long lttng_abi_add_context(struct file *file,
204 struct lttng_kernel_context *context_param,
205 struct lttng_ctx **ctx, struct lttng_session *session)
206 {
207
208 if (session->been_active)
209 return -EPERM;
210
211 switch (context_param->ctx) {
212 case LTTNG_KERNEL_CONTEXT_PID:
213 return lttng_add_pid_to_ctx(ctx);
214 case LTTNG_KERNEL_CONTEXT_PRIO:
215 return lttng_add_prio_to_ctx(ctx);
216 case LTTNG_KERNEL_CONTEXT_NICE:
217 return lttng_add_nice_to_ctx(ctx);
218 case LTTNG_KERNEL_CONTEXT_VPID:
219 return lttng_add_vpid_to_ctx(ctx);
220 case LTTNG_KERNEL_CONTEXT_TID:
221 return lttng_add_tid_to_ctx(ctx);
222 case LTTNG_KERNEL_CONTEXT_VTID:
223 return lttng_add_vtid_to_ctx(ctx);
224 case LTTNG_KERNEL_CONTEXT_PPID:
225 return lttng_add_ppid_to_ctx(ctx);
226 case LTTNG_KERNEL_CONTEXT_VPPID:
227 return lttng_add_vppid_to_ctx(ctx);
228 case LTTNG_KERNEL_CONTEXT_PERF_COUNTER:
229 context_param->u.perf_counter.name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
230 return lttng_add_perf_counter_to_ctx(context_param->u.perf_counter.type,
231 context_param->u.perf_counter.config,
232 context_param->u.perf_counter.name,
233 ctx);
234 case LTTNG_KERNEL_CONTEXT_PROCNAME:
235 return lttng_add_procname_to_ctx(ctx);
236 case LTTNG_KERNEL_CONTEXT_HOSTNAME:
237 return lttng_add_hostname_to_ctx(ctx);
238 case LTTNG_KERNEL_CONTEXT_CPU_ID:
239 return lttng_add_cpu_id_to_ctx(ctx);
240 case LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE:
241 return lttng_add_interruptible_to_ctx(ctx);
242 case LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE:
243 return lttng_add_need_reschedule_to_ctx(ctx);
244 case LTTNG_KERNEL_CONTEXT_PREEMPTIBLE:
245 return lttng_add_preemptible_to_ctx(ctx);
246 case LTTNG_KERNEL_CONTEXT_MIGRATABLE:
247 return lttng_add_migratable_to_ctx(ctx);
248 default:
249 return -EINVAL;
250 }
251 }
252
253 /**
254 * lttng_ioctl - lttng syscall through ioctl
255 *
256 * @file: the file
257 * @cmd: the command
258 * @arg: command arg
259 *
260 * This ioctl implements lttng commands:
261 * LTTNG_KERNEL_SESSION
262 * Returns a LTTng trace session file descriptor
263 * LTTNG_KERNEL_TRACER_VERSION
264 * Returns the LTTng kernel tracer version
265 * LTTNG_KERNEL_TRACEPOINT_LIST
266 * Returns a file descriptor listing available tracepoints
267 * LTTNG_KERNEL_WAIT_QUIESCENT
268 * Returns after all previously running probes have completed
269 * LTTNG_KERNEL_TRACER_ABI_VERSION
270 * Returns the LTTng kernel tracer ABI version
271 *
272 * The returned session will be deleted when its file descriptor is closed.
273 */
274 static
275 long lttng_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
276 {
277 switch (cmd) {
278 case LTTNG_KERNEL_OLD_SESSION:
279 case LTTNG_KERNEL_SESSION:
280 return lttng_abi_create_session();
281 case LTTNG_KERNEL_OLD_TRACER_VERSION:
282 {
283 struct lttng_kernel_tracer_version v;
284 struct lttng_kernel_old_tracer_version oldv;
285 struct lttng_kernel_old_tracer_version *uversion =
286 (struct lttng_kernel_old_tracer_version __user *) arg;
287
288 lttng_abi_tracer_version(&v);
289 oldv.major = v.major;
290 oldv.minor = v.minor;
291 oldv.patchlevel = v.patchlevel;
292
293 if (copy_to_user(uversion, &oldv, sizeof(oldv)))
294 return -EFAULT;
295 return 0;
296 }
297 case LTTNG_KERNEL_TRACER_VERSION:
298 {
299 struct lttng_kernel_tracer_version version;
300 struct lttng_kernel_tracer_version *uversion =
301 (struct lttng_kernel_tracer_version __user *) arg;
302
303 lttng_abi_tracer_version(&version);
304
305 if (copy_to_user(uversion, &version, sizeof(version)))
306 return -EFAULT;
307 return 0;
308 }
309 case LTTNG_KERNEL_TRACER_ABI_VERSION:
310 {
311 struct lttng_kernel_tracer_abi_version version;
312 struct lttng_kernel_tracer_abi_version *uversion =
313 (struct lttng_kernel_tracer_abi_version __user *) arg;
314
315 lttng_abi_tracer_abi_version(&version);
316
317 if (copy_to_user(uversion, &version, sizeof(version)))
318 return -EFAULT;
319 return 0;
320 }
321 case LTTNG_KERNEL_OLD_TRACEPOINT_LIST:
322 case LTTNG_KERNEL_TRACEPOINT_LIST:
323 return lttng_abi_tracepoint_list();
324 case LTTNG_KERNEL_SYSCALL_LIST:
325 return lttng_abi_syscall_list();
326 case LTTNG_KERNEL_OLD_WAIT_QUIESCENT:
327 case LTTNG_KERNEL_WAIT_QUIESCENT:
328 synchronize_trace();
329 return 0;
330 case LTTNG_KERNEL_OLD_CALIBRATE:
331 {
332 struct lttng_kernel_old_calibrate __user *ucalibrate =
333 (struct lttng_kernel_old_calibrate __user *) arg;
334 struct lttng_kernel_old_calibrate old_calibrate;
335 struct lttng_kernel_calibrate calibrate;
336 int ret;
337
338 if (copy_from_user(&old_calibrate, ucalibrate, sizeof(old_calibrate)))
339 return -EFAULT;
340 calibrate.type = old_calibrate.type;
341 ret = lttng_calibrate(&calibrate);
342 if (copy_to_user(ucalibrate, &old_calibrate, sizeof(old_calibrate)))
343 return -EFAULT;
344 return ret;
345 }
346 case LTTNG_KERNEL_CALIBRATE:
347 {
348 struct lttng_kernel_calibrate __user *ucalibrate =
349 (struct lttng_kernel_calibrate __user *) arg;
350 struct lttng_kernel_calibrate calibrate;
351 int ret;
352
353 if (copy_from_user(&calibrate, ucalibrate, sizeof(calibrate)))
354 return -EFAULT;
355 ret = lttng_calibrate(&calibrate);
356 if (copy_to_user(ucalibrate, &calibrate, sizeof(calibrate)))
357 return -EFAULT;
358 return ret;
359 }
360 default:
361 return -ENOIOCTLCMD;
362 }
363 }
364
365 static const struct file_operations lttng_fops = {
366 .owner = THIS_MODULE,
367 .unlocked_ioctl = lttng_ioctl,
368 #ifdef CONFIG_COMPAT
369 .compat_ioctl = lttng_ioctl,
370 #endif
371 };
372
373 static
374 int lttng_abi_create_channel(struct file *session_file,
375 struct lttng_kernel_channel *chan_param,
376 enum channel_type channel_type)
377 {
378 struct lttng_session *session = session_file->private_data;
379 const struct file_operations *fops = NULL;
380 const char *transport_name;
381 struct lttng_channel *chan;
382 struct file *chan_file;
383 int chan_fd;
384 int ret = 0;
385
386 chan_fd = lttng_get_unused_fd();
387 if (chan_fd < 0) {
388 ret = chan_fd;
389 goto fd_error;
390 }
391 switch (channel_type) {
392 case PER_CPU_CHANNEL:
393 fops = &lttng_channel_fops;
394 break;
395 case METADATA_CHANNEL:
396 fops = &lttng_metadata_fops;
397 break;
398 }
399
400 chan_file = anon_inode_getfile("[lttng_channel]",
401 fops,
402 NULL, O_RDWR);
403 if (IS_ERR(chan_file)) {
404 ret = PTR_ERR(chan_file);
405 goto file_error;
406 }
407 switch (channel_type) {
408 case PER_CPU_CHANNEL:
409 if (chan_param->output == LTTNG_KERNEL_SPLICE) {
410 transport_name = chan_param->overwrite ?
411 "relay-overwrite" : "relay-discard";
412 } else if (chan_param->output == LTTNG_KERNEL_MMAP) {
413 transport_name = chan_param->overwrite ?
414 "relay-overwrite-mmap" : "relay-discard-mmap";
415 } else {
416 return -EINVAL;
417 }
418 break;
419 case METADATA_CHANNEL:
420 if (chan_param->output == LTTNG_KERNEL_SPLICE)
421 transport_name = "relay-metadata";
422 else if (chan_param->output == LTTNG_KERNEL_MMAP)
423 transport_name = "relay-metadata-mmap";
424 else
425 return -EINVAL;
426 break;
427 default:
428 transport_name = "<unknown>";
429 break;
430 }
431 if (atomic_long_add_unless(&session_file->f_count,
432 1, INT_MAX) == INT_MAX) {
433 goto refcount_error;
434 }
435 /*
436 * We tolerate no failure path after channel creation. It will stay
437 * invariant for the rest of the session.
438 */
439 chan = lttng_channel_create(session, transport_name, NULL,
440 chan_param->subbuf_size,
441 chan_param->num_subbuf,
442 chan_param->switch_timer_interval,
443 chan_param->read_timer_interval,
444 channel_type);
445 if (!chan) {
446 ret = -EINVAL;
447 goto chan_error;
448 }
449 chan->file = chan_file;
450 chan_file->private_data = chan;
451 fd_install(chan_fd, chan_file);
452
453 return chan_fd;
454
455 chan_error:
456 atomic_long_dec(&session_file->f_count);
457 refcount_error:
458 fput(chan_file);
459 file_error:
460 put_unused_fd(chan_fd);
461 fd_error:
462 return ret;
463 }
464
465 /**
466 * lttng_session_ioctl - lttng session fd ioctl
467 *
468 * @file: the file
469 * @cmd: the command
470 * @arg: command arg
471 *
472 * This ioctl implements lttng commands:
473 * LTTNG_KERNEL_CHANNEL
474 * Returns a LTTng channel file descriptor
475 * LTTNG_KERNEL_ENABLE
476 * Enables tracing for a session (weak enable)
477 * LTTNG_KERNEL_DISABLE
478 * Disables tracing for a session (strong disable)
479 * LTTNG_KERNEL_METADATA
480 * Returns a LTTng metadata file descriptor
481 * LTTNG_KERNEL_SESSION_TRACK_PID
482 * Add PID to session tracker
483 * LTTNG_KERNEL_SESSION_UNTRACK_PID
484 * Remove PID from session tracker
485 *
486 * The returned channel will be deleted when its file descriptor is closed.
487 */
488 static
489 long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
490 {
491 struct lttng_session *session = file->private_data;
492
493 switch (cmd) {
494 case LTTNG_KERNEL_OLD_CHANNEL:
495 {
496 struct lttng_kernel_channel chan_param;
497 struct lttng_kernel_old_channel old_chan_param;
498
499 if (copy_from_user(&old_chan_param,
500 (struct lttng_kernel_old_channel __user *) arg,
501 sizeof(struct lttng_kernel_old_channel)))
502 return -EFAULT;
503 chan_param.overwrite = old_chan_param.overwrite;
504 chan_param.subbuf_size = old_chan_param.subbuf_size;
505 chan_param.num_subbuf = old_chan_param.num_subbuf;
506 chan_param.switch_timer_interval = old_chan_param.switch_timer_interval;
507 chan_param.read_timer_interval = old_chan_param.read_timer_interval;
508 chan_param.output = old_chan_param.output;
509
510 return lttng_abi_create_channel(file, &chan_param,
511 PER_CPU_CHANNEL);
512 }
513 case LTTNG_KERNEL_CHANNEL:
514 {
515 struct lttng_kernel_channel chan_param;
516
517 if (copy_from_user(&chan_param,
518 (struct lttng_kernel_channel __user *) arg,
519 sizeof(struct lttng_kernel_channel)))
520 return -EFAULT;
521 return lttng_abi_create_channel(file, &chan_param,
522 PER_CPU_CHANNEL);
523 }
524 case LTTNG_KERNEL_OLD_SESSION_START:
525 case LTTNG_KERNEL_OLD_ENABLE:
526 case LTTNG_KERNEL_SESSION_START:
527 case LTTNG_KERNEL_ENABLE:
528 return lttng_session_enable(session);
529 case LTTNG_KERNEL_OLD_SESSION_STOP:
530 case LTTNG_KERNEL_OLD_DISABLE:
531 case LTTNG_KERNEL_SESSION_STOP:
532 case LTTNG_KERNEL_DISABLE:
533 return lttng_session_disable(session);
534 case LTTNG_KERNEL_OLD_METADATA:
535 {
536 struct lttng_kernel_channel chan_param;
537 struct lttng_kernel_old_channel old_chan_param;
538
539 if (copy_from_user(&old_chan_param,
540 (struct lttng_kernel_old_channel __user *) arg,
541 sizeof(struct lttng_kernel_old_channel)))
542 return -EFAULT;
543 chan_param.overwrite = old_chan_param.overwrite;
544 chan_param.subbuf_size = old_chan_param.subbuf_size;
545 chan_param.num_subbuf = old_chan_param.num_subbuf;
546 chan_param.switch_timer_interval = old_chan_param.switch_timer_interval;
547 chan_param.read_timer_interval = old_chan_param.read_timer_interval;
548 chan_param.output = old_chan_param.output;
549
550 return lttng_abi_create_channel(file, &chan_param,
551 METADATA_CHANNEL);
552 }
553 case LTTNG_KERNEL_METADATA:
554 {
555 struct lttng_kernel_channel chan_param;
556
557 if (copy_from_user(&chan_param,
558 (struct lttng_kernel_channel __user *) arg,
559 sizeof(struct lttng_kernel_channel)))
560 return -EFAULT;
561 return lttng_abi_create_channel(file, &chan_param,
562 METADATA_CHANNEL);
563 }
564 case LTTNG_KERNEL_SESSION_TRACK_PID:
565 return lttng_session_track_pid(session, (int) arg);
566 case LTTNG_KERNEL_SESSION_UNTRACK_PID:
567 return lttng_session_untrack_pid(session, (int) arg);
568 case LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS:
569 return lttng_session_list_tracker_pids(session);
570 case LTTNG_KERNEL_SESSION_METADATA_REGEN:
571 return lttng_session_metadata_regenerate(session);
572 default:
573 return -ENOIOCTLCMD;
574 }
575 }
576
577 /*
578 * Called when the last file reference is dropped.
579 *
580 * Big fat note: channels and events are invariant for the whole session after
581 * their creation. So this session destruction also destroys all channel and
582 * event structures specific to this session (they are not destroyed when their
583 * individual file is released).
584 */
585 static
586 int lttng_session_release(struct inode *inode, struct file *file)
587 {
588 struct lttng_session *session = file->private_data;
589
590 if (session)
591 lttng_session_destroy(session);
592 return 0;
593 }
594
595 static const struct file_operations lttng_session_fops = {
596 .owner = THIS_MODULE,
597 .release = lttng_session_release,
598 .unlocked_ioctl = lttng_session_ioctl,
599 #ifdef CONFIG_COMPAT
600 .compat_ioctl = lttng_session_ioctl,
601 #endif
602 };
603
604 /**
605 * lttng_metadata_ring_buffer_poll - LTTng ring buffer poll file operation
606 * @filp: the file
607 * @wait: poll table
608 *
609 * Handles the poll operations for the metadata channels.
610 */
611 static
612 unsigned int lttng_metadata_ring_buffer_poll(struct file *filp,
613 poll_table *wait)
614 {
615 struct lttng_metadata_stream *stream = filp->private_data;
616 struct lib_ring_buffer *buf = stream->priv;
617 int finalized;
618 unsigned int mask = 0;
619
620 if (filp->f_mode & FMODE_READ) {
621 poll_wait_set_exclusive(wait);
622 poll_wait(filp, &stream->read_wait, wait);
623
624 finalized = stream->finalized;
625
626 /*
627 * lib_ring_buffer_is_finalized() contains a smp_rmb()
628 * ordering finalized load before offsets loads.
629 */
630 WARN_ON(atomic_long_read(&buf->active_readers) != 1);
631
632 if (finalized)
633 mask |= POLLHUP;
634
635 mutex_lock(&stream->metadata_cache->lock);
636 if (stream->metadata_cache->metadata_written >
637 stream->metadata_out)
638 mask |= POLLIN;
639 mutex_unlock(&stream->metadata_cache->lock);
640 }
641
642 return mask;
643 }
644
645 static
646 void lttng_metadata_ring_buffer_ioctl_put_next_subbuf(struct file *filp,
647 unsigned int cmd, unsigned long arg)
648 {
649 struct lttng_metadata_stream *stream = filp->private_data;
650
651 stream->metadata_out = stream->metadata_in;
652 }
653
654 static
655 long lttng_metadata_ring_buffer_ioctl(struct file *filp,
656 unsigned int cmd, unsigned long arg)
657 {
658 int ret;
659 struct lttng_metadata_stream *stream = filp->private_data;
660 struct lib_ring_buffer *buf = stream->priv;
661
662 switch (cmd) {
663 case RING_BUFFER_GET_NEXT_SUBBUF:
664 {
665 struct lttng_metadata_stream *stream = filp->private_data;
666 struct lib_ring_buffer *buf = stream->priv;
667 struct channel *chan = buf->backend.chan;
668
669 ret = lttng_metadata_output_channel(stream, chan);
670 if (ret > 0) {
671 lib_ring_buffer_switch_slow(buf, SWITCH_ACTIVE);
672 ret = 0;
673 } else if (ret < 0)
674 goto err;
675 break;
676 }
677 case RING_BUFFER_GET_SUBBUF:
678 {
679 /*
680 * Random access is not allowed for metadata channel.
681 */
682 return -ENOSYS;
683 }
684 case RING_BUFFER_FLUSH:
685 {
686 struct lttng_metadata_stream *stream = filp->private_data;
687 struct lib_ring_buffer *buf = stream->priv;
688 struct channel *chan = buf->backend.chan;
689
690 /*
691 * Before doing the actual ring buffer flush, write up to one
692 * packet of metadata in the ring buffer.
693 */
694 ret = lttng_metadata_output_channel(stream, chan);
695 if (ret < 0)
696 goto err;
697 break;
698 }
699 case RING_BUFFER_GET_METADATA_VERSION:
700 {
701 struct lttng_metadata_stream *stream = filp->private_data;
702
703 return put_u64(stream->version, arg);
704 }
705 case RING_BUFFER_SNAPSHOT:
706 {
707 /*
708 * Force the buffer to quiescent so the ring buffer
709 * don't attempt to perform a SWITCH_FLUSH, which would
710 * desynchronize the client accounting of the amount of
711 * data available in the buffer from the ring buffer
712 * view.
713 */
714 buf->quiescent = true;
715 break;
716 }
717 default:
718 break;
719 }
720 /* PUT_SUBBUF is the one from lib ring buffer, unmodified. */
721
722 /* Performing lib ring buffer ioctl after our own. */
723 ret = lib_ring_buffer_ioctl(filp, cmd, arg, buf);
724 if (ret < 0)
725 goto err;
726
727 switch (cmd) {
728 case RING_BUFFER_PUT_NEXT_SUBBUF:
729 {
730 lttng_metadata_ring_buffer_ioctl_put_next_subbuf(filp,
731 cmd, arg);
732 break;
733 }
734 default:
735 break;
736 }
737 err:
738 return ret;
739 }
740
741 #ifdef CONFIG_COMPAT
742 static
743 long lttng_metadata_ring_buffer_compat_ioctl(struct file *filp,
744 unsigned int cmd, unsigned long arg)
745 {
746 int ret;
747 struct lttng_metadata_stream *stream = filp->private_data;
748 struct lib_ring_buffer *buf = stream->priv;
749
750 switch (cmd) {
751 case RING_BUFFER_GET_NEXT_SUBBUF:
752 {
753 struct lttng_metadata_stream *stream = filp->private_data;
754 struct lib_ring_buffer *buf = stream->priv;
755 struct channel *chan = buf->backend.chan;
756
757 ret = lttng_metadata_output_channel(stream, chan);
758 if (ret > 0) {
759 lib_ring_buffer_switch_slow(buf, SWITCH_ACTIVE);
760 ret = 0;
761 } else if (ret < 0)
762 goto err;
763 break;
764 }
765 case RING_BUFFER_GET_SUBBUF:
766 {
767 /*
768 * Random access is not allowed for metadata channel.
769 */
770 return -ENOSYS;
771 }
772 case RING_BUFFER_FLUSH:
773 {
774 struct lttng_metadata_stream *stream = filp->private_data;
775 struct lib_ring_buffer *buf = stream->priv;
776 struct channel *chan = buf->backend.chan;
777
778 /*
779 * Before doing the actual ring buffer flush, write up to one
780 * packet of metadata in the ring buffer.
781 */
782 ret = lttng_metadata_output_channel(stream, chan);
783 if (ret < 0)
784 goto err;
785 break;
786 }
787 case RING_BUFFER_GET_METADATA_VERSION:
788 {
789 struct lttng_metadata_stream *stream = filp->private_data;
790
791 return put_u64(stream->version, arg);
792 }
793 case RING_BUFFER_SNAPSHOT:
794 {
795 /*
796 * Force the buffer to quiescent so the ring buffer
797 * don't attempt to perform a SWITCH_FLUSH, which would
798 * desynchronize the client accounting of the amount of
799 * data available in the buffer from the ring buffer
800 * view.
801 */
802 buf->quiescent = true;
803 break;
804 }
805 default:
806 break;
807 }
808 /* PUT_SUBBUF is the one from lib ring buffer, unmodified. */
809
810 /* Performing lib ring buffer ioctl after our own. */
811 ret = lib_ring_buffer_compat_ioctl(filp, cmd, arg, buf);
812 if (ret < 0)
813 goto err;
814
815 switch (cmd) {
816 case RING_BUFFER_PUT_NEXT_SUBBUF:
817 {
818 lttng_metadata_ring_buffer_ioctl_put_next_subbuf(filp,
819 cmd, arg);
820 break;
821 }
822 default:
823 break;
824 }
825 err:
826 return ret;
827 }
828 #endif
829
830 /*
831 * This is not used by anonymous file descriptors. This code is left
832 * there if we ever want to implement an inode with open() operation.
833 */
834 static
835 int lttng_metadata_ring_buffer_open(struct inode *inode, struct file *file)
836 {
837 struct lttng_metadata_stream *stream = inode->i_private;
838 struct lib_ring_buffer *buf = stream->priv;
839
840 file->private_data = buf;
841 /*
842 * Since life-time of metadata cache differs from that of
843 * session, we need to keep our own reference on the transport.
844 */
845 if (!try_module_get(stream->transport->owner)) {
846 printk(KERN_WARNING "LTT : Can't lock transport module.\n");
847 return -EBUSY;
848 }
849 return lib_ring_buffer_open(inode, file, buf);
850 }
851
852 static
853 int lttng_metadata_ring_buffer_release(struct inode *inode, struct file *file)
854 {
855 struct lttng_metadata_stream *stream = file->private_data;
856 struct lib_ring_buffer *buf = stream->priv;
857
858 kref_put(&stream->metadata_cache->refcount, metadata_cache_destroy);
859 module_put(stream->transport->owner);
860 return lib_ring_buffer_release(inode, file, buf);
861 }
862
863 static
864 ssize_t lttng_metadata_ring_buffer_splice_read(struct file *in, loff_t *ppos,
865 struct pipe_inode_info *pipe, size_t len,
866 unsigned int flags)
867 {
868 struct lttng_metadata_stream *stream = in->private_data;
869 struct lib_ring_buffer *buf = stream->priv;
870
871 return lib_ring_buffer_splice_read(in, ppos, pipe, len,
872 flags, buf);
873 }
874
875 static
876 int lttng_metadata_ring_buffer_mmap(struct file *filp,
877 struct vm_area_struct *vma)
878 {
879 struct lttng_metadata_stream *stream = filp->private_data;
880 struct lib_ring_buffer *buf = stream->priv;
881
882 return lib_ring_buffer_mmap(filp, vma, buf);
883 }
884
885 static
886 const struct file_operations lttng_metadata_ring_buffer_file_operations = {
887 .owner = THIS_MODULE,
888 .open = lttng_metadata_ring_buffer_open,
889 .release = lttng_metadata_ring_buffer_release,
890 .poll = lttng_metadata_ring_buffer_poll,
891 .splice_read = lttng_metadata_ring_buffer_splice_read,
892 .mmap = lttng_metadata_ring_buffer_mmap,
893 .unlocked_ioctl = lttng_metadata_ring_buffer_ioctl,
894 .llseek = vfs_lib_ring_buffer_no_llseek,
895 #ifdef CONFIG_COMPAT
896 .compat_ioctl = lttng_metadata_ring_buffer_compat_ioctl,
897 #endif
898 };
899
900 static
901 int lttng_abi_create_stream_fd(struct file *channel_file, void *stream_priv,
902 const struct file_operations *fops)
903 {
904 int stream_fd, ret;
905 struct file *stream_file;
906
907 stream_fd = lttng_get_unused_fd();
908 if (stream_fd < 0) {
909 ret = stream_fd;
910 goto fd_error;
911 }
912 stream_file = anon_inode_getfile("[lttng_stream]", fops,
913 stream_priv, O_RDWR);
914 if (IS_ERR(stream_file)) {
915 ret = PTR_ERR(stream_file);
916 goto file_error;
917 }
918 /*
919 * OPEN_FMODE, called within anon_inode_getfile/alloc_file, don't honor
920 * FMODE_LSEEK, FMODE_PREAD nor FMODE_PWRITE. We need to read from this
921 * file descriptor, so we set FMODE_PREAD here.
922 */
923 stream_file->f_mode |= FMODE_PREAD;
924 fd_install(stream_fd, stream_file);
925 /*
926 * The stream holds a reference to the channel within the generic ring
927 * buffer library, so no need to hold a refcount on the channel and
928 * session files here.
929 */
930 return stream_fd;
931
932 file_error:
933 put_unused_fd(stream_fd);
934 fd_error:
935 return ret;
936 }
937
938 static
939 int lttng_abi_open_stream(struct file *channel_file)
940 {
941 struct lttng_channel *channel = channel_file->private_data;
942 struct lib_ring_buffer *buf;
943 int ret;
944 void *stream_priv;
945
946 buf = channel->ops->buffer_read_open(channel->chan);
947 if (!buf)
948 return -ENOENT;
949
950 stream_priv = buf;
951 ret = lttng_abi_create_stream_fd(channel_file, stream_priv,
952 &lttng_stream_ring_buffer_file_operations);
953 if (ret < 0)
954 goto fd_error;
955
956 return ret;
957
958 fd_error:
959 channel->ops->buffer_read_close(buf);
960 return ret;
961 }
962
963 static
964 int lttng_abi_open_metadata_stream(struct file *channel_file)
965 {
966 struct lttng_channel *channel = channel_file->private_data;
967 struct lttng_session *session = channel->session;
968 struct lib_ring_buffer *buf;
969 int ret;
970 struct lttng_metadata_stream *metadata_stream;
971 void *stream_priv;
972
973 buf = channel->ops->buffer_read_open(channel->chan);
974 if (!buf)
975 return -ENOENT;
976
977 metadata_stream = kzalloc(sizeof(struct lttng_metadata_stream),
978 GFP_KERNEL);
979 if (!metadata_stream) {
980 ret = -ENOMEM;
981 goto nomem;
982 }
983 metadata_stream->metadata_cache = session->metadata_cache;
984 init_waitqueue_head(&metadata_stream->read_wait);
985 metadata_stream->priv = buf;
986 stream_priv = metadata_stream;
987 metadata_stream->transport = channel->transport;
988
989 /*
990 * Since life-time of metadata cache differs from that of
991 * session, we need to keep our own reference on the transport.
992 */
993 if (!try_module_get(metadata_stream->transport->owner)) {
994 printk(KERN_WARNING "LTT : Can't lock transport module.\n");
995 ret = -EINVAL;
996 goto notransport;
997 }
998
999 if (!lttng_kref_get(&session->metadata_cache->refcount)) {
1000 ret = -EOVERFLOW;
1001 goto kref_error;
1002 }
1003
1004 ret = lttng_abi_create_stream_fd(channel_file, stream_priv,
1005 &lttng_metadata_ring_buffer_file_operations);
1006 if (ret < 0)
1007 goto fd_error;
1008
1009 list_add(&metadata_stream->list,
1010 &session->metadata_cache->metadata_stream);
1011 return ret;
1012
1013 fd_error:
1014 kref_put(&session->metadata_cache->refcount, metadata_cache_destroy);
1015 kref_error:
1016 module_put(metadata_stream->transport->owner);
1017 notransport:
1018 kfree(metadata_stream);
1019 nomem:
1020 channel->ops->buffer_read_close(buf);
1021 return ret;
1022 }
1023
1024 static
1025 int lttng_abi_create_event(struct file *channel_file,
1026 struct lttng_kernel_event *event_param)
1027 {
1028 struct lttng_channel *channel = channel_file->private_data;
1029 int event_fd, ret;
1030 struct file *event_file;
1031 void *priv;
1032
1033 event_param->name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
1034 switch (event_param->instrumentation) {
1035 case LTTNG_KERNEL_KRETPROBE:
1036 event_param->u.kretprobe.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
1037 break;
1038 case LTTNG_KERNEL_KPROBE:
1039 event_param->u.kprobe.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
1040 break;
1041 case LTTNG_KERNEL_FUNCTION:
1042 event_param->u.ftrace.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
1043 break;
1044 default:
1045 break;
1046 }
1047 event_fd = lttng_get_unused_fd();
1048 if (event_fd < 0) {
1049 ret = event_fd;
1050 goto fd_error;
1051 }
1052 event_file = anon_inode_getfile("[lttng_event]",
1053 &lttng_event_fops,
1054 NULL, O_RDWR);
1055 if (IS_ERR(event_file)) {
1056 ret = PTR_ERR(event_file);
1057 goto file_error;
1058 }
1059 /* The event holds a reference on the channel */
1060 if (atomic_long_add_unless(&channel_file->f_count,
1061 1, INT_MAX) == INT_MAX) {
1062 ret = -EOVERFLOW;
1063 goto refcount_error;
1064 }
1065 if (event_param->instrumentation == LTTNG_KERNEL_TRACEPOINT
1066 || event_param->instrumentation == LTTNG_KERNEL_SYSCALL) {
1067 struct lttng_enabler *enabler;
1068
1069 if (event_param->name[strlen(event_param->name) - 1] == '*') {
1070 enabler = lttng_enabler_create(LTTNG_ENABLER_WILDCARD,
1071 event_param, channel);
1072 } else {
1073 enabler = lttng_enabler_create(LTTNG_ENABLER_NAME,
1074 event_param, channel);
1075 }
1076 priv = enabler;
1077 } else {
1078 struct lttng_event *event;
1079
1080 /*
1081 * We tolerate no failure path after event creation. It
1082 * will stay invariant for the rest of the session.
1083 */
1084 event = lttng_event_create(channel, event_param,
1085 NULL, NULL,
1086 event_param->instrumentation);
1087 WARN_ON_ONCE(!event);
1088 if (IS_ERR(event)) {
1089 ret = PTR_ERR(event);
1090 goto event_error;
1091 }
1092 priv = event;
1093 }
1094 event_file->private_data = priv;
1095 fd_install(event_fd, event_file);
1096 return event_fd;
1097
1098 event_error:
1099 atomic_long_dec(&channel_file->f_count);
1100 refcount_error:
1101 fput(event_file);
1102 file_error:
1103 put_unused_fd(event_fd);
1104 fd_error:
1105 return ret;
1106 }
1107
1108 /**
1109 * lttng_channel_ioctl - lttng syscall through ioctl
1110 *
1111 * @file: the file
1112 * @cmd: the command
1113 * @arg: command arg
1114 *
1115 * This ioctl implements lttng commands:
1116 * LTTNG_KERNEL_STREAM
1117 * Returns an event stream file descriptor or failure.
1118 * (typically, one event stream records events from one CPU)
1119 * LTTNG_KERNEL_EVENT
1120 * Returns an event file descriptor or failure.
1121 * LTTNG_KERNEL_CONTEXT
1122 * Prepend a context field to each event in the channel
1123 * LTTNG_KERNEL_ENABLE
1124 * Enable recording for events in this channel (weak enable)
1125 * LTTNG_KERNEL_DISABLE
1126 * Disable recording for events in this channel (strong disable)
1127 *
1128 * Channel and event file descriptors also hold a reference on the session.
1129 */
1130 static
1131 long lttng_channel_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1132 {
1133 struct lttng_channel *channel = file->private_data;
1134
1135 switch (cmd) {
1136 case LTTNG_KERNEL_OLD_STREAM:
1137 case LTTNG_KERNEL_STREAM:
1138 return lttng_abi_open_stream(file);
1139 case LTTNG_KERNEL_OLD_EVENT:
1140 {
1141 struct lttng_kernel_event *uevent_param;
1142 struct lttng_kernel_old_event *old_uevent_param;
1143 int ret;
1144
1145 uevent_param = kmalloc(sizeof(struct lttng_kernel_event),
1146 GFP_KERNEL);
1147 if (!uevent_param) {
1148 ret = -ENOMEM;
1149 goto old_event_end;
1150 }
1151 old_uevent_param = kmalloc(
1152 sizeof(struct lttng_kernel_old_event),
1153 GFP_KERNEL);
1154 if (!old_uevent_param) {
1155 ret = -ENOMEM;
1156 goto old_event_error_free_param;
1157 }
1158 if (copy_from_user(old_uevent_param,
1159 (struct lttng_kernel_old_event __user *) arg,
1160 sizeof(struct lttng_kernel_old_event))) {
1161 ret = -EFAULT;
1162 goto old_event_error_free_old_param;
1163 }
1164
1165 memcpy(uevent_param->name, old_uevent_param->name,
1166 sizeof(uevent_param->name));
1167 uevent_param->instrumentation =
1168 old_uevent_param->instrumentation;
1169
1170 switch (old_uevent_param->instrumentation) {
1171 case LTTNG_KERNEL_KPROBE:
1172 uevent_param->u.kprobe.addr =
1173 old_uevent_param->u.kprobe.addr;
1174 uevent_param->u.kprobe.offset =
1175 old_uevent_param->u.kprobe.offset;
1176 memcpy(uevent_param->u.kprobe.symbol_name,
1177 old_uevent_param->u.kprobe.symbol_name,
1178 sizeof(uevent_param->u.kprobe.symbol_name));
1179 break;
1180 case LTTNG_KERNEL_KRETPROBE:
1181 uevent_param->u.kretprobe.addr =
1182 old_uevent_param->u.kretprobe.addr;
1183 uevent_param->u.kretprobe.offset =
1184 old_uevent_param->u.kretprobe.offset;
1185 memcpy(uevent_param->u.kretprobe.symbol_name,
1186 old_uevent_param->u.kretprobe.symbol_name,
1187 sizeof(uevent_param->u.kretprobe.symbol_name));
1188 break;
1189 case LTTNG_KERNEL_FUNCTION:
1190 memcpy(uevent_param->u.ftrace.symbol_name,
1191 old_uevent_param->u.ftrace.symbol_name,
1192 sizeof(uevent_param->u.ftrace.symbol_name));
1193 break;
1194 default:
1195 break;
1196 }
1197 ret = lttng_abi_create_event(file, uevent_param);
1198
1199 old_event_error_free_old_param:
1200 kfree(old_uevent_param);
1201 old_event_error_free_param:
1202 kfree(uevent_param);
1203 old_event_end:
1204 return ret;
1205 }
1206 case LTTNG_KERNEL_EVENT:
1207 {
1208 struct lttng_kernel_event uevent_param;
1209
1210 if (copy_from_user(&uevent_param,
1211 (struct lttng_kernel_event __user *) arg,
1212 sizeof(uevent_param)))
1213 return -EFAULT;
1214 return lttng_abi_create_event(file, &uevent_param);
1215 }
1216 case LTTNG_KERNEL_OLD_CONTEXT:
1217 {
1218 struct lttng_kernel_context *ucontext_param;
1219 struct lttng_kernel_old_context *old_ucontext_param;
1220 int ret;
1221
1222 ucontext_param = kmalloc(sizeof(struct lttng_kernel_context),
1223 GFP_KERNEL);
1224 if (!ucontext_param) {
1225 ret = -ENOMEM;
1226 goto old_ctx_end;
1227 }
1228 old_ucontext_param = kmalloc(sizeof(struct lttng_kernel_old_context),
1229 GFP_KERNEL);
1230 if (!old_ucontext_param) {
1231 ret = -ENOMEM;
1232 goto old_ctx_error_free_param;
1233 }
1234
1235 if (copy_from_user(old_ucontext_param,
1236 (struct lttng_kernel_old_context __user *) arg,
1237 sizeof(struct lttng_kernel_old_context))) {
1238 ret = -EFAULT;
1239 goto old_ctx_error_free_old_param;
1240 }
1241 ucontext_param->ctx = old_ucontext_param->ctx;
1242 memcpy(ucontext_param->padding, old_ucontext_param->padding,
1243 sizeof(ucontext_param->padding));
1244 /* only type that uses the union */
1245 if (old_ucontext_param->ctx == LTTNG_KERNEL_CONTEXT_PERF_COUNTER) {
1246 ucontext_param->u.perf_counter.type =
1247 old_ucontext_param->u.perf_counter.type;
1248 ucontext_param->u.perf_counter.config =
1249 old_ucontext_param->u.perf_counter.config;
1250 memcpy(ucontext_param->u.perf_counter.name,
1251 old_ucontext_param->u.perf_counter.name,
1252 sizeof(ucontext_param->u.perf_counter.name));
1253 }
1254
1255 ret = lttng_abi_add_context(file,
1256 ucontext_param,
1257 &channel->ctx, channel->session);
1258
1259 old_ctx_error_free_old_param:
1260 kfree(old_ucontext_param);
1261 old_ctx_error_free_param:
1262 kfree(ucontext_param);
1263 old_ctx_end:
1264 return ret;
1265 }
1266 case LTTNG_KERNEL_CONTEXT:
1267 {
1268 struct lttng_kernel_context ucontext_param;
1269
1270 if (copy_from_user(&ucontext_param,
1271 (struct lttng_kernel_context __user *) arg,
1272 sizeof(ucontext_param)))
1273 return -EFAULT;
1274 return lttng_abi_add_context(file,
1275 &ucontext_param,
1276 &channel->ctx, channel->session);
1277 }
1278 case LTTNG_KERNEL_OLD_ENABLE:
1279 case LTTNG_KERNEL_ENABLE:
1280 return lttng_channel_enable(channel);
1281 case LTTNG_KERNEL_OLD_DISABLE:
1282 case LTTNG_KERNEL_DISABLE:
1283 return lttng_channel_disable(channel);
1284 case LTTNG_KERNEL_SYSCALL_MASK:
1285 return lttng_channel_syscall_mask(channel,
1286 (struct lttng_kernel_syscall_mask __user *) arg);
1287 default:
1288 return -ENOIOCTLCMD;
1289 }
1290
1291 }
1292
1293 /**
1294 * lttng_metadata_ioctl - lttng syscall through ioctl
1295 *
1296 * @file: the file
1297 * @cmd: the command
1298 * @arg: command arg
1299 *
1300 * This ioctl implements lttng commands:
1301 * LTTNG_KERNEL_STREAM
1302 * Returns an event stream file descriptor or failure.
1303 *
1304 * Channel and event file descriptors also hold a reference on the session.
1305 */
1306 static
1307 long lttng_metadata_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1308 {
1309 switch (cmd) {
1310 case LTTNG_KERNEL_OLD_STREAM:
1311 case LTTNG_KERNEL_STREAM:
1312 return lttng_abi_open_metadata_stream(file);
1313 default:
1314 return -ENOIOCTLCMD;
1315 }
1316 }
1317
1318 /**
1319 * lttng_channel_poll - lttng stream addition/removal monitoring
1320 *
1321 * @file: the file
1322 * @wait: poll table
1323 */
1324 unsigned int lttng_channel_poll(struct file *file, poll_table *wait)
1325 {
1326 struct lttng_channel *channel = file->private_data;
1327 unsigned int mask = 0;
1328
1329 if (file->f_mode & FMODE_READ) {
1330 poll_wait_set_exclusive(wait);
1331 poll_wait(file, channel->ops->get_hp_wait_queue(channel->chan),
1332 wait);
1333
1334 if (channel->ops->is_disabled(channel->chan))
1335 return POLLERR;
1336 if (channel->ops->is_finalized(channel->chan))
1337 return POLLHUP;
1338 if (channel->ops->buffer_has_read_closed_stream(channel->chan))
1339 return POLLIN | POLLRDNORM;
1340 return 0;
1341 }
1342 return mask;
1343
1344 }
1345
1346 static
1347 int lttng_channel_release(struct inode *inode, struct file *file)
1348 {
1349 struct lttng_channel *channel = file->private_data;
1350
1351 if (channel)
1352 fput(channel->session->file);
1353 return 0;
1354 }
1355
1356 static
1357 int lttng_metadata_channel_release(struct inode *inode, struct file *file)
1358 {
1359 struct lttng_channel *channel = file->private_data;
1360
1361 if (channel) {
1362 fput(channel->session->file);
1363 lttng_metadata_channel_destroy(channel);
1364 }
1365
1366 return 0;
1367 }
1368
1369 static const struct file_operations lttng_channel_fops = {
1370 .owner = THIS_MODULE,
1371 .release = lttng_channel_release,
1372 .poll = lttng_channel_poll,
1373 .unlocked_ioctl = lttng_channel_ioctl,
1374 #ifdef CONFIG_COMPAT
1375 .compat_ioctl = lttng_channel_ioctl,
1376 #endif
1377 };
1378
1379 static const struct file_operations lttng_metadata_fops = {
1380 .owner = THIS_MODULE,
1381 .release = lttng_metadata_channel_release,
1382 .unlocked_ioctl = lttng_metadata_ioctl,
1383 #ifdef CONFIG_COMPAT
1384 .compat_ioctl = lttng_metadata_ioctl,
1385 #endif
1386 };
1387
1388 /**
1389 * lttng_event_ioctl - lttng syscall through ioctl
1390 *
1391 * @file: the file
1392 * @cmd: the command
1393 * @arg: command arg
1394 *
1395 * This ioctl implements lttng commands:
1396 * LTTNG_KERNEL_CONTEXT
1397 * Prepend a context field to each record of this event
1398 * LTTNG_KERNEL_ENABLE
1399 * Enable recording for this event (weak enable)
1400 * LTTNG_KERNEL_DISABLE
1401 * Disable recording for this event (strong disable)
1402 */
1403 static
1404 long lttng_event_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1405 {
1406 struct lttng_event *event;
1407 struct lttng_enabler *enabler;
1408 enum lttng_event_type *evtype = file->private_data;
1409
1410 switch (cmd) {
1411 case LTTNG_KERNEL_OLD_CONTEXT:
1412 {
1413 /* Not implemented */
1414 return -ENOSYS;
1415 }
1416 case LTTNG_KERNEL_CONTEXT:
1417 {
1418 /* Not implemented */
1419 return -ENOSYS;
1420 }
1421 case LTTNG_KERNEL_OLD_ENABLE:
1422 case LTTNG_KERNEL_ENABLE:
1423 switch (*evtype) {
1424 case LTTNG_TYPE_EVENT:
1425 event = file->private_data;
1426 return lttng_event_enable(event);
1427 case LTTNG_TYPE_ENABLER:
1428 enabler = file->private_data;
1429 return lttng_enabler_enable(enabler);
1430 default:
1431 WARN_ON_ONCE(1);
1432 return -ENOSYS;
1433 }
1434 case LTTNG_KERNEL_OLD_DISABLE:
1435 case LTTNG_KERNEL_DISABLE:
1436 switch (*evtype) {
1437 case LTTNG_TYPE_EVENT:
1438 event = file->private_data;
1439 return lttng_event_disable(event);
1440 case LTTNG_TYPE_ENABLER:
1441 enabler = file->private_data;
1442 return lttng_enabler_disable(enabler);
1443 default:
1444 WARN_ON_ONCE(1);
1445 return -ENOSYS;
1446 }
1447 case LTTNG_KERNEL_FILTER:
1448 switch (*evtype) {
1449 case LTTNG_TYPE_EVENT:
1450 return -EINVAL;
1451 case LTTNG_TYPE_ENABLER:
1452 {
1453 enabler = file->private_data;
1454 return lttng_enabler_attach_bytecode(enabler,
1455 (struct lttng_kernel_filter_bytecode __user *) arg);
1456 }
1457
1458 }
1459 default:
1460 return -ENOIOCTLCMD;
1461 }
1462 }
1463
1464 static
1465 int lttng_event_release(struct inode *inode, struct file *file)
1466 {
1467 struct lttng_event *event;
1468 struct lttng_enabler *enabler;
1469 enum lttng_event_type *evtype = file->private_data;
1470
1471 if (!evtype)
1472 return 0;
1473
1474 switch (*evtype) {
1475 case LTTNG_TYPE_EVENT:
1476 event = file->private_data;
1477 if (event)
1478 fput(event->chan->file);
1479 break;
1480 case LTTNG_TYPE_ENABLER:
1481 enabler = file->private_data;
1482 if (enabler)
1483 fput(enabler->chan->file);
1484 break;
1485 default:
1486 WARN_ON_ONCE(1);
1487 break;
1488 }
1489
1490 return 0;
1491 }
1492
1493 /* TODO: filter control ioctl */
1494 static const struct file_operations lttng_event_fops = {
1495 .owner = THIS_MODULE,
1496 .release = lttng_event_release,
1497 .unlocked_ioctl = lttng_event_ioctl,
1498 #ifdef CONFIG_COMPAT
1499 .compat_ioctl = lttng_event_ioctl,
1500 #endif
1501 };
1502
1503 static int put_u64(uint64_t val, unsigned long arg)
1504 {
1505 return put_user(val, (uint64_t __user *) arg);
1506 }
1507
1508 static long lttng_stream_ring_buffer_ioctl(struct file *filp,
1509 unsigned int cmd, unsigned long arg)
1510 {
1511 struct lib_ring_buffer *buf = filp->private_data;
1512 struct channel *chan = buf->backend.chan;
1513 const struct lib_ring_buffer_config *config = &chan->backend.config;
1514 const struct lttng_channel_ops *ops = chan->backend.priv_ops;
1515 int ret;
1516
1517 if (atomic_read(&chan->record_disabled))
1518 return -EIO;
1519
1520 switch (cmd) {
1521 case LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN:
1522 {
1523 uint64_t ts;
1524
1525 ret = ops->timestamp_begin(config, buf, &ts);
1526 if (ret < 0)
1527 goto error;
1528 return put_u64(ts, arg);
1529 }
1530 case LTTNG_RING_BUFFER_GET_TIMESTAMP_END:
1531 {
1532 uint64_t ts;
1533
1534 ret = ops->timestamp_end(config, buf, &ts);
1535 if (ret < 0)
1536 goto error;
1537 return put_u64(ts, arg);
1538 }
1539 case LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED:
1540 {
1541 uint64_t ed;
1542
1543 ret = ops->events_discarded(config, buf, &ed);
1544 if (ret < 0)
1545 goto error;
1546 return put_u64(ed, arg);
1547 }
1548 case LTTNG_RING_BUFFER_GET_CONTENT_SIZE:
1549 {
1550 uint64_t cs;
1551
1552 ret = ops->content_size(config, buf, &cs);
1553 if (ret < 0)
1554 goto error;
1555 return put_u64(cs, arg);
1556 }
1557 case LTTNG_RING_BUFFER_GET_PACKET_SIZE:
1558 {
1559 uint64_t ps;
1560
1561 ret = ops->packet_size(config, buf, &ps);
1562 if (ret < 0)
1563 goto error;
1564 return put_u64(ps, arg);
1565 }
1566 case LTTNG_RING_BUFFER_GET_STREAM_ID:
1567 {
1568 uint64_t si;
1569
1570 ret = ops->stream_id(config, buf, &si);
1571 if (ret < 0)
1572 goto error;
1573 return put_u64(si, arg);
1574 }
1575 case LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP:
1576 {
1577 uint64_t ts;
1578
1579 ret = ops->current_timestamp(config, buf, &ts);
1580 if (ret < 0)
1581 goto error;
1582 return put_u64(ts, arg);
1583 }
1584 case LTTNG_RING_BUFFER_GET_SEQ_NUM:
1585 {
1586 uint64_t seq;
1587
1588 ret = ops->sequence_number(config, buf, &seq);
1589 if (ret < 0)
1590 goto error;
1591 return put_u64(seq, arg);
1592 }
1593 case LTTNG_RING_BUFFER_INSTANCE_ID:
1594 {
1595 uint64_t id;
1596
1597 ret = ops->instance_id(config, buf, &id);
1598 if (ret < 0)
1599 goto error;
1600 return put_u64(id, arg);
1601 }
1602 default:
1603 return lib_ring_buffer_file_operations.unlocked_ioctl(filp,
1604 cmd, arg);
1605 }
1606
1607 error:
1608 return -ENOSYS;
1609 }
1610
1611 #ifdef CONFIG_COMPAT
1612 static long lttng_stream_ring_buffer_compat_ioctl(struct file *filp,
1613 unsigned int cmd, unsigned long arg)
1614 {
1615 struct lib_ring_buffer *buf = filp->private_data;
1616 struct channel *chan = buf->backend.chan;
1617 const struct lib_ring_buffer_config *config = &chan->backend.config;
1618 const struct lttng_channel_ops *ops = chan->backend.priv_ops;
1619 int ret;
1620
1621 if (atomic_read(&chan->record_disabled))
1622 return -EIO;
1623
1624 switch (cmd) {
1625 case LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN:
1626 {
1627 uint64_t ts;
1628
1629 ret = ops->timestamp_begin(config, buf, &ts);
1630 if (ret < 0)
1631 goto error;
1632 return put_u64(ts, arg);
1633 }
1634 case LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END:
1635 {
1636 uint64_t ts;
1637
1638 ret = ops->timestamp_end(config, buf, &ts);
1639 if (ret < 0)
1640 goto error;
1641 return put_u64(ts, arg);
1642 }
1643 case LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED:
1644 {
1645 uint64_t ed;
1646
1647 ret = ops->events_discarded(config, buf, &ed);
1648 if (ret < 0)
1649 goto error;
1650 return put_u64(ed, arg);
1651 }
1652 case LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE:
1653 {
1654 uint64_t cs;
1655
1656 ret = ops->content_size(config, buf, &cs);
1657 if (ret < 0)
1658 goto error;
1659 return put_u64(cs, arg);
1660 }
1661 case LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE:
1662 {
1663 uint64_t ps;
1664
1665 ret = ops->packet_size(config, buf, &ps);
1666 if (ret < 0)
1667 goto error;
1668 return put_u64(ps, arg);
1669 }
1670 case LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID:
1671 {
1672 uint64_t si;
1673
1674 ret = ops->stream_id(config, buf, &si);
1675 if (ret < 0)
1676 goto error;
1677 return put_u64(si, arg);
1678 }
1679 case LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP:
1680 {
1681 uint64_t ts;
1682
1683 ret = ops->current_timestamp(config, buf, &ts);
1684 if (ret < 0)
1685 goto error;
1686 return put_u64(ts, arg);
1687 }
1688 case LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM:
1689 {
1690 uint64_t seq;
1691
1692 ret = ops->sequence_number(config, buf, &seq);
1693 if (ret < 0)
1694 goto error;
1695 return put_u64(seq, arg);
1696 }
1697 case LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID:
1698 {
1699 uint64_t id;
1700
1701 ret = ops->instance_id(config, buf, &id);
1702 if (ret < 0)
1703 goto error;
1704 return put_u64(id, arg);
1705 }
1706 default:
1707 return lib_ring_buffer_file_operations.compat_ioctl(filp,
1708 cmd, arg);
1709 }
1710
1711 error:
1712 return -ENOSYS;
1713 }
1714 #endif /* CONFIG_COMPAT */
1715
1716 static void lttng_stream_override_ring_buffer_fops(void)
1717 {
1718 lttng_stream_ring_buffer_file_operations.owner = THIS_MODULE;
1719 lttng_stream_ring_buffer_file_operations.open =
1720 lib_ring_buffer_file_operations.open;
1721 lttng_stream_ring_buffer_file_operations.release =
1722 lib_ring_buffer_file_operations.release;
1723 lttng_stream_ring_buffer_file_operations.poll =
1724 lib_ring_buffer_file_operations.poll;
1725 lttng_stream_ring_buffer_file_operations.splice_read =
1726 lib_ring_buffer_file_operations.splice_read;
1727 lttng_stream_ring_buffer_file_operations.mmap =
1728 lib_ring_buffer_file_operations.mmap;
1729 lttng_stream_ring_buffer_file_operations.unlocked_ioctl =
1730 lttng_stream_ring_buffer_ioctl;
1731 lttng_stream_ring_buffer_file_operations.llseek =
1732 lib_ring_buffer_file_operations.llseek;
1733 #ifdef CONFIG_COMPAT
1734 lttng_stream_ring_buffer_file_operations.compat_ioctl =
1735 lttng_stream_ring_buffer_compat_ioctl;
1736 #endif
1737 }
1738
1739 int __init lttng_abi_init(void)
1740 {
1741 int ret = 0;
1742
1743 wrapper_vmalloc_sync_all();
1744 lttng_clock_ref();
1745 lttng_proc_dentry = proc_create_data("lttng", S_IRUSR | S_IWUSR, NULL,
1746 &lttng_fops, NULL);
1747
1748 if (!lttng_proc_dentry) {
1749 printk(KERN_ERR "Error creating LTTng control file\n");
1750 ret = -ENOMEM;
1751 goto error;
1752 }
1753 lttng_stream_override_ring_buffer_fops();
1754 return 0;
1755
1756 error:
1757 lttng_clock_unref();
1758 return ret;
1759 }
1760
1761 /* No __exit annotation because used by init error path too. */
1762 void lttng_abi_exit(void)
1763 {
1764 lttng_clock_unref();
1765 if (lttng_proc_dentry)
1766 remove_proc_entry("lttng", NULL);
1767 }
This page took 0.065121 seconds and 4 git commands to generate.