Add ltt-debugfs-abi.h
[deliverable/lttng-modules.git] / ltt-debugfs-abi.c
CommitLineData
baf20995
MD
1/*
2 * ltt-debugfs-abi.c
3 *
4 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * LTTng debugfs ABI
7 *
8 * Mimic system calls for:
9 * - session creation, returns a file descriptor or failure.
ad1c05e1
MD
10 * - channel creation, returns a file descriptor or failure.
11 * - Operates on a session file descriptor
12 * - Takes all channel options as parameters.
13 * - stream get, returns a file descriptor or failure.
14 * - Operates on a channel file descriptor.
15 * - stream notifier get, returns a file descriptor or failure.
16 * - Operates on a channel file descriptor.
17 * - event creation, returns a file descriptor or failure.
18 * - Operates on a channel file descriptor
19 * - Takes an event name as parameter
20 * - Takes an instrumentation source as parameter
21 * - e.g. tracepoints, dynamic_probes...
22 * - Takes instrumentation source specific arguments.
baf20995
MD
23 */
24
11b5a3c2 25#include <linux/module.h>
baf20995 26#include <linux/debugfs.h>
11b5a3c2
MD
27#include <linux/anon_inodes.h>
28#include <linux/file.h>
29#include <linux/uaccess.h>
30#include <linux/slab.h>
31#include <linux/ringbuffer/vfs.h>
32#include "ltt-debugfs-abi.h"
ad1c05e1 33#include "ltt-events.h"
baf20995
MD
34
35/*
36 * This is LTTng's own personal way to create a system call as an external
37 * module. We use ioctl() on /sys/kernel/debug/lttng.
38 */
39
40static struct dentry *lttng_dentry;
ad1c05e1
MD
41static const struct file_operations lttng_fops;
42static const struct file_operations lttng_session_fops;
43static const struct file_operations lttng_channel_fops;
305d3e42 44static const struct file_operations lttng_event_fops;
baf20995 45
ad1c05e1 46static
baf20995
MD
47int lttng_abi_create_session(void)
48{
49 struct ltt_session *session;
c0e31d2e 50 struct file *session_file;
11b5a3c2 51 int session_fd, ret;
baf20995 52
653fe716 53 session = ltt_session_create();
baf20995
MD
54 if (!session)
55 return -ENOMEM;
56 session_fd = get_unused_fd_flags(O_RDWR);
57 if (session_fd < 0) {
58 ret = session_fd;
59 goto fd_error;
60 }
c0e31d2e 61 session_file = anon_inode_getfile("[lttng_session]",
ad1c05e1 62 &lttng_session_fops,
baf20995 63 session, O_RDWR);
c0e31d2e
MD
64 if (IS_ERR(session_file)) {
65 ret = PTR_ERR(session_file);
baf20995
MD
66 goto file_error;
67 }
c0e31d2e
MD
68 session->file = session_file;
69 fd_install(session_fd, session_file);
baf20995
MD
70 return session_fd;
71
72file_error:
73 put_unused_fd(session_fd);
74fd_error:
75 ltt_session_destroy(session);
76 return ret;
77}
78
ad1c05e1
MD
79/**
80 * lttng_ioctl - lttng syscall through ioctl
81 *
c0e31d2e 82 * @file: the file
ad1c05e1
MD
83 * @cmd: the command
84 * @arg: command arg
85 *
86 * This ioctl implements lttng commands:
87 * LTTNG_SESSION
88 * Returns a LTTng trace session file descriptor
89 *
90 * The returned session will be deleted when its file descriptor is closed.
91 */
92static
c0e31d2e 93long lttng_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
ad1c05e1
MD
94{
95 switch (cmd) {
96 case LTTNG_SESSION:
97 return lttng_abi_create_session();
98 default:
99 return -ENOIOCTLCMD;
100 }
101}
102
ad1c05e1
MD
103static const struct file_operations lttng_fops = {
104 .unlocked_ioctl = lttng_ioctl,
105#ifdef CONFIG_COMPAT
03037b98 106 .compat_ioctl = lttng_ioctl,
ad1c05e1 107#endif
11b5a3c2 108};
ad1c05e1 109
c0e31d2e 110int lttng_abi_create_channel(struct file *session_file,
ad1c05e1 111 struct lttng_channel __user *uchan_param)
baf20995 112{
c0e31d2e 113 struct ltt_session *session = session_file->private_data;
baf20995 114 struct ltt_channel *chan;
c0e31d2e 115 struct file *chan_file;
baf20995
MD
116 struct lttng_channel chan_param;
117 int chan_fd;
ad1c05e1 118 int ret = 0;
baf20995 119
653fe716 120 if (copy_from_user(&chan_param, uchan_param, sizeof(chan_param)))
baf20995 121 return -EFAULT;
baf20995
MD
122 chan_fd = get_unused_fd_flags(O_RDWR);
123 if (chan_fd < 0) {
124 ret = chan_fd;
125 goto fd_error;
126 }
c0e31d2e 127 chan_file = anon_inode_getfile("[lttng_channel]",
ad1c05e1 128 &lttng_channel_fops,
03037b98 129 NULL, O_RDWR);
c0e31d2e
MD
130 if (IS_ERR(chan_file)) {
131 ret = PTR_ERR(chan_file);
baf20995
MD
132 goto file_error;
133 }
03037b98
MD
134 /*
135 * We tolerate no failure path after channel creation. It will stay
136 * invariant for the rest of the session.
137 */
11b5a3c2
MD
138 chan = ltt_channel_create(session, chan_param.overwrite, NULL,
139 chan_param.subbuf_size,
140 chan_param.num_subbuf,
141 chan_param.switch_timer_interval,
142 chan_param.read_timer_interval);
03037b98
MD
143 if (!chan) {
144 ret = -ENOMEM;
145 goto chan_error;
146 }
11b5a3c2 147 chan->file = chan_file;
c0e31d2e
MD
148 chan_file->private_data = chan;
149 fd_install(chan_fd, chan_file);
ad1c05e1 150 /* The channel created holds a reference on the session */
c0e31d2e 151 atomic_inc(&session_file->f_count);
ad1c05e1 152
baf20995
MD
153 return chan_fd;
154
03037b98 155chan_error:
c0e31d2e 156 fput(chan_file);
baf20995
MD
157file_error:
158 put_unused_fd(chan_fd);
159fd_error:
baf20995
MD
160 return ret;
161}
162
163/**
ad1c05e1 164 * lttng_session_ioctl - lttng session fd ioctl
baf20995 165 *
c0e31d2e 166 * @file: the file
baf20995
MD
167 * @cmd: the command
168 * @arg: command arg
169 *
170 * This ioctl implements lttng commands:
baf20995
MD
171 * LTTNG_CHANNEL
172 * Returns a LTTng channel file descriptor
ad1c05e1
MD
173 *
174 * The returned channel will be deleted when its file descriptor is closed.
175 */
176static
c0e31d2e 177long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
ad1c05e1 178{
c0e31d2e
MD
179 struct ltt_session *session = file->private_data;
180
ad1c05e1
MD
181 switch (cmd) {
182 case LTTNG_CHANNEL:
c0e31d2e
MD
183 return lttng_abi_create_channel(file, (struct lttng_channel __user *)arg);
184 case LTTNG_SESSION_START:
185 return ltt_session_start(session);
186 case LTTNG_SESSION_STOP:
187 return ltt_session_stop(session);
ad1c05e1
MD
188 default:
189 return -ENOIOCTLCMD;
190 }
191}
192
03037b98
MD
193/*
194 * Called when the last file reference is dropped.
195 *
196 * Big fat note: channels and events are invariant for the whole session after
197 * their creation. So this session destruction also destroys all channel and
198 * event structures specific to this session (they are not destroyed when their
199 * individual file is released).
200 */
ad1c05e1 201static
03037b98 202int lttng_session_release(struct inode *inode, struct file *file)
ad1c05e1 203{
03037b98 204 struct ltt_session *session = file->private_data;
11b5a3c2
MD
205 ltt_session_destroy(session);
206 return 0;
ad1c05e1 207}
ad1c05e1
MD
208
209static const struct file_operations lttng_session_fops = {
03037b98 210 .release = lttng_session_release,
ad1c05e1
MD
211 .unlocked_ioctl = lttng_session_ioctl,
212#ifdef CONFIG_COMPAT
03037b98 213 .compat_ioctl = lttng_session_ioctl,
ad1c05e1 214#endif
11b5a3c2 215};
ad1c05e1
MD
216
217static
c0e31d2e 218int lttng_abi_open_stream(struct file *channel_file)
ad1c05e1 219{
c0e31d2e 220 struct ltt_channel *channel = channel_file->private_data;
ad1c05e1
MD
221 struct lib_ring_buffer *buf;
222 int stream_fd, ret;
11b5a3c2 223 struct file *stream_file;
ad1c05e1 224
11b5a3c2 225 buf = channel->ops->buffer_read_open(channel->chan);
ad1c05e1
MD
226 if (!buf)
227 return -ENOENT;
228
229 stream_fd = get_unused_fd_flags(O_RDWR);
230 if (stream_fd < 0) {
231 ret = stream_fd;
232 goto fd_error;
233 }
c0e31d2e 234 stream_file = anon_inode_getfile("[lttng_stream]",
7f57c73c 235 &lib_ring_buffer_file_operations,
ad1c05e1 236 buf, O_RDWR);
c0e31d2e
MD
237 if (IS_ERR(stream_file)) {
238 ret = PTR_ERR(stream_file);
ad1c05e1
MD
239 goto file_error;
240 }
c0e31d2e 241 fd_install(stream_fd, stream_file);
ad1c05e1 242 /* The stream holds a reference on the channel */
c0e31d2e 243 atomic_inc(&channel_file->f_count);
ad1c05e1
MD
244 return stream_fd;
245
246file_error:
247 put_unused_fd(stream_fd);
248fd_error:
11b5a3c2 249 channel->ops->buffer_read_close(buf);
ad1c05e1
MD
250 return ret;
251}
252
653fe716 253static
c0e31d2e 254int lttng_abi_create_event(struct file *channel_file,
653fe716
MD
255 struct lttng_event __user *uevent_param)
256{
c0e31d2e 257 struct ltt_channel *channel = channel_file->private_data;
653fe716
MD
258 struct ltt_event *event;
259 char *event_name;
260 struct lttng_event event_param;
261 int event_fd, ret;
11b5a3c2 262 struct file *event_file;
653fe716
MD
263
264 if (copy_from_user(&event_param, uevent_param, sizeof(event_param)))
265 return -EFAULT;
266 event_name = kmalloc(PATH_MAX, GFP_KERNEL);
267 if (!event_name)
268 return -ENOMEM;
11b5a3c2 269 if (strncpy_from_user(event_name, uevent_param->name, PATH_MAX)) {
653fe716
MD
270 ret = -EFAULT;
271 goto name_error;
272 }
273 event_name[PATH_MAX - 1] = '\0';
653fe716
MD
274 event_fd = get_unused_fd_flags(O_RDWR);
275 if (event_fd < 0) {
276 ret = event_fd;
277 goto fd_error;
278 }
c0e31d2e 279 event_file = anon_inode_getfile("[lttng_event]",
3b923e5b 280 &lttng_event_fops,
03037b98 281 NULL, O_RDWR);
c0e31d2e
MD
282 if (IS_ERR(event_file)) {
283 ret = PTR_ERR(event_file);
653fe716
MD
284 goto file_error;
285 }
03037b98
MD
286 /*
287 * We tolerate no failure path after event creation. It will stay
288 * invariant for the rest of the session.
289 */
11b5a3c2
MD
290 event = ltt_event_create(channel, event_name, event_param.itype,
291 NULL, NULL); /* TODO non-null probe */
03037b98
MD
292 if (!event) {
293 goto event_error;
294 ret = -EEXIST;
295 }
c0e31d2e
MD
296 event_file->private_data = event;
297 fd_install(event_fd, event_file);
653fe716 298 /* The event holds a reference on the channel */
c0e31d2e 299 atomic_inc(&channel_file->f_count);
03037b98 300 kfree(event_name);
653fe716
MD
301 return event_fd;
302
03037b98 303event_error:
c0e31d2e 304 fput(event_file);
653fe716
MD
305file_error:
306 put_unused_fd(event_fd);
307fd_error:
653fe716
MD
308name_error:
309 kfree(event_name);
310 return ret;
311}
ad1c05e1
MD
312
313/**
314 * lttng_channel_ioctl - lttng syscall through ioctl
315 *
c0e31d2e 316 * @file: the file
ad1c05e1
MD
317 * @cmd: the command
318 * @arg: command arg
319 *
320 * This ioctl implements lttng commands:
321 * LTTNG_STREAM
322 * Returns an event stream file descriptor or failure.
323 * (typically, one event stream records events from one CPU)
baf20995 324 * LTTNG_EVENT
ad1c05e1 325 * Returns an event file descriptor or failure.
baf20995
MD
326 *
327 * The returned session will be deleted when its file descriptor is closed.
328 * Channel and event file descriptors also hold a reference on the session.
329 */
ad1c05e1 330static
c0e31d2e 331long lttng_channel_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
baf20995 332{
baf20995 333 switch (cmd) {
ad1c05e1 334 case LTTNG_STREAM:
c0e31d2e 335 return lttng_abi_open_stream(file);
baf20995 336 case LTTNG_EVENT:
c0e31d2e 337 return lttng_abi_create_event(file, (struct lttng_event __user *)arg);
baf20995
MD
338 default:
339 return -ENOIOCTLCMD;
340 }
341}
342
3b923e5b
MD
343/* TODO: poll */
344#if 0
653fe716
MD
345/**
346 * lttng_channel_poll - lttng stream addition/removal monitoring
347 *
c0e31d2e 348 * @file: the file
653fe716
MD
349 * @wait: poll table
350 */
c0e31d2e 351unsigned int lttng_channel_poll(struct file *file, poll_table *wait)
653fe716 352{
c0e31d2e 353 struct ltt_channel *channel = file->private_data;
653fe716
MD
354 unsigned int mask = 0;
355
c0e31d2e 356 if (file->f_mode & FMODE_READ) {
653fe716 357 poll_wait_set_exclusive(wait);
c0e31d2e 358 poll_wait(file, &channel->notify_wait, wait);
653fe716
MD
359
360 /* TODO: identify when the channel is being finalized. */
361 if (finalized)
362 return POLLHUP;
363 else
364 return POLLIN | POLLRDNORM;
365 }
366 return mask;
367
368}
3b923e5b 369#endif //0
653fe716 370
0a84a57f
MD
371static
372int lttng_channel_release(struct inode *inode, struct file *file)
373{
374 struct ltt_channel *channel = file->private_data;
375 fput(channel->session->file);
376 return 0;
377}
378
ad1c05e1 379static const struct file_operations lttng_channel_fops = {
03037b98 380 .release = lttng_channel_release,
3b923e5b
MD
381/* TODO */
382#if 0
653fe716 383 .poll = lttng_channel_poll,
3b923e5b 384#endif //0
ad1c05e1 385 .unlocked_ioctl = lttng_channel_ioctl,
baf20995 386#ifdef CONFIG_COMPAT
03037b98 387 .compat_ioctl = lttng_channel_ioctl,
baf20995 388#endif
11b5a3c2 389};
baf20995 390
0a84a57f
MD
391static
392int lttng_event_release(struct inode *inode, struct file *file)
393{
394 struct ltt_event *event = file->private_data;
395 fput(event->chan->file);
396 return 0;
397}
398
3b923e5b 399/* TODO: filter control ioctl */
0a84a57f
MD
400static const struct file_operations lttng_event_fops = {
401 .release = lttng_event_release,
11b5a3c2 402};
0a84a57f 403
baf20995
MD
404static int __init ltt_debugfs_abi_init(void)
405{
406 int ret = 0;
407
11b5a3c2
MD
408 lttng_dentry = debugfs_create_file("lttng", S_IWUSR, NULL, NULL,
409 &lttng_session_fops);
410 if (IS_ERR(lttng_dentry) || !lttng_dentry) {
baf20995
MD
411 printk(KERN_ERR "Error creating LTTng control file\n");
412 ret = -ENOMEM;
413 goto error;
414 }
415error:
416 return ret;
417}
418
11b5a3c2
MD
419module_init(ltt_debugfs_abi_init);
420
baf20995
MD
421static void __exit ltt_debugfs_abi_exit(void)
422{
11b5a3c2 423 debugfs_remove(lttng_dentry);
baf20995 424}
11b5a3c2
MD
425
426module_exit(ltt_debugfs_abi_exit);
427
428MODULE_LICENSE("GPL and additional rights");
429MODULE_AUTHOR("Mathieu Desnoyers");
430MODULE_DESCRIPTION("Linux Trace Toolkit Next Generation DebugFS ABI");
This page took 0.197057 seconds and 5 git commands to generate.