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