]> bbs.cooldavid.org Git - net-next-2.6.git/blame - fs/notify/fanotify/fanotify_user.c
fanotify: infrastructure to add an remove marks on vfsmounts
[net-next-2.6.git] / fs / notify / fanotify / fanotify_user.c
CommitLineData
11637e4b 1#include <linux/fcntl.h>
2a3edf86 2#include <linux/file.h>
11637e4b 3#include <linux/fs.h>
52c923dd 4#include <linux/anon_inodes.h>
11637e4b 5#include <linux/fsnotify_backend.h>
2a3edf86 6#include <linux/init.h>
a1014f10 7#include <linux/mount.h>
2a3edf86 8#include <linux/namei.h>
a1014f10 9#include <linux/poll.h>
11637e4b
EP
10#include <linux/security.h>
11#include <linux/syscalls.h>
2a3edf86 12#include <linux/types.h>
a1014f10
EP
13#include <linux/uaccess.h>
14
15#include <asm/ioctls.h>
11637e4b
EP
16
17#include "fanotify.h"
18
2a3edf86
EP
19static struct kmem_cache *fanotify_mark_cache __read_mostly;
20
a1014f10
EP
21/*
22 * Get an fsnotify notification event if one exists and is small
23 * enough to fit in "count". Return an error pointer if the count
24 * is not large enough.
25 *
26 * Called with the group->notification_mutex held.
27 */
28static struct fsnotify_event *get_one_event(struct fsnotify_group *group,
29 size_t count)
30{
31 BUG_ON(!mutex_is_locked(&group->notification_mutex));
32
33 pr_debug("%s: group=%p count=%zd\n", __func__, group, count);
34
35 if (fsnotify_notify_queue_is_empty(group))
36 return NULL;
37
38 if (FAN_EVENT_METADATA_LEN > count)
39 return ERR_PTR(-EINVAL);
40
41 /* held the notification_mutex the whole time, so this is the
42 * same event we peeked above */
43 return fsnotify_remove_notify_event(group);
44}
45
22aa425d 46static int create_fd(struct fsnotify_group *group, struct fsnotify_event *event)
a1014f10
EP
47{
48 int client_fd;
49 struct dentry *dentry;
50 struct vfsmount *mnt;
51 struct file *new_file;
52
22aa425d 53 pr_debug("%s: group=%p event=%p\n", __func__, group, event);
a1014f10
EP
54
55 client_fd = get_unused_fd();
56 if (client_fd < 0)
57 return client_fd;
58
59 if (event->data_type != FSNOTIFY_EVENT_PATH) {
60 WARN_ON(1);
61 put_unused_fd(client_fd);
62 return -EINVAL;
63 }
64
65 /*
66 * we need a new file handle for the userspace program so it can read even if it was
67 * originally opened O_WRONLY.
68 */
69 dentry = dget(event->path.dentry);
70 mnt = mntget(event->path.mnt);
71 /* it's possible this event was an overflow event. in that case dentry and mnt
72 * are NULL; That's fine, just don't call dentry open */
73 if (dentry && mnt)
74 new_file = dentry_open(dentry, mnt,
75 O_RDONLY | O_LARGEFILE | FMODE_NONOTIFY,
76 current_cred());
77 else
78 new_file = ERR_PTR(-EOVERFLOW);
79 if (IS_ERR(new_file)) {
80 /*
81 * we still send an event even if we can't open the file. this
82 * can happen when say tasks are gone and we try to open their
83 * /proc files or we try to open a WRONLY file like in sysfs
84 * we just send the errno to userspace since there isn't much
85 * else we can do.
86 */
87 put_unused_fd(client_fd);
88 client_fd = PTR_ERR(new_file);
89 } else {
90 fd_install(client_fd, new_file);
91 }
92
22aa425d 93 return client_fd;
a1014f10
EP
94}
95
96static ssize_t fill_event_metadata(struct fsnotify_group *group,
97 struct fanotify_event_metadata *metadata,
98 struct fsnotify_event *event)
99{
100 pr_debug("%s: group=%p metadata=%p event=%p\n", __func__,
101 group, metadata, event);
102
103 metadata->event_len = FAN_EVENT_METADATA_LEN;
104 metadata->vers = FANOTIFY_METADATA_VERSION;
105 metadata->mask = fanotify_outgoing_mask(event->mask);
32c32632 106 metadata->pid = pid_vnr(event->tgid);
22aa425d 107 metadata->fd = create_fd(group, event);
a1014f10 108
22aa425d 109 return metadata->fd;
a1014f10
EP
110}
111
112static ssize_t copy_event_to_user(struct fsnotify_group *group,
113 struct fsnotify_event *event,
114 char __user *buf)
115{
116 struct fanotify_event_metadata fanotify_event_metadata;
117 int ret;
118
119 pr_debug("%s: group=%p event=%p\n", __func__, group, event);
120
121 ret = fill_event_metadata(group, &fanotify_event_metadata, event);
22aa425d 122 if (ret < 0)
a1014f10
EP
123 return ret;
124
125 if (copy_to_user(buf, &fanotify_event_metadata, FAN_EVENT_METADATA_LEN))
126 return -EFAULT;
127
128 return FAN_EVENT_METADATA_LEN;
129}
130
131/* intofiy userspace file descriptor functions */
132static unsigned int fanotify_poll(struct file *file, poll_table *wait)
133{
134 struct fsnotify_group *group = file->private_data;
135 int ret = 0;
136
137 poll_wait(file, &group->notification_waitq, wait);
138 mutex_lock(&group->notification_mutex);
139 if (!fsnotify_notify_queue_is_empty(group))
140 ret = POLLIN | POLLRDNORM;
141 mutex_unlock(&group->notification_mutex);
142
143 return ret;
144}
145
146static ssize_t fanotify_read(struct file *file, char __user *buf,
147 size_t count, loff_t *pos)
148{
149 struct fsnotify_group *group;
150 struct fsnotify_event *kevent;
151 char __user *start;
152 int ret;
153 DEFINE_WAIT(wait);
154
155 start = buf;
156 group = file->private_data;
157
158 pr_debug("%s: group=%p\n", __func__, group);
159
160 while (1) {
161 prepare_to_wait(&group->notification_waitq, &wait, TASK_INTERRUPTIBLE);
162
163 mutex_lock(&group->notification_mutex);
164 kevent = get_one_event(group, count);
165 mutex_unlock(&group->notification_mutex);
166
167 if (kevent) {
168 ret = PTR_ERR(kevent);
169 if (IS_ERR(kevent))
170 break;
171 ret = copy_event_to_user(group, kevent, buf);
172 fsnotify_put_event(kevent);
173 if (ret < 0)
174 break;
175 buf += ret;
176 count -= ret;
177 continue;
178 }
179
180 ret = -EAGAIN;
181 if (file->f_flags & O_NONBLOCK)
182 break;
183 ret = -EINTR;
184 if (signal_pending(current))
185 break;
186
187 if (start != buf)
188 break;
189
190 schedule();
191 }
192
193 finish_wait(&group->notification_waitq, &wait);
194 if (start != buf && ret != -EFAULT)
195 ret = buf - start;
196 return ret;
197}
198
52c923dd
EP
199static int fanotify_release(struct inode *ignored, struct file *file)
200{
201 struct fsnotify_group *group = file->private_data;
202
203 pr_debug("%s: file=%p group=%p\n", __func__, file, group);
204
205 /* matches the fanotify_init->fsnotify_alloc_group */
206 fsnotify_put_group(group);
207
208 return 0;
209}
210
a1014f10
EP
211static long fanotify_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
212{
213 struct fsnotify_group *group;
214 struct fsnotify_event_holder *holder;
215 void __user *p;
216 int ret = -ENOTTY;
217 size_t send_len = 0;
218
219 group = file->private_data;
220
221 p = (void __user *) arg;
222
223 switch (cmd) {
224 case FIONREAD:
225 mutex_lock(&group->notification_mutex);
226 list_for_each_entry(holder, &group->notification_list, event_list)
227 send_len += FAN_EVENT_METADATA_LEN;
228 mutex_unlock(&group->notification_mutex);
229 ret = put_user(send_len, (int __user *) p);
230 break;
231 }
232
233 return ret;
234}
235
52c923dd 236static const struct file_operations fanotify_fops = {
a1014f10
EP
237 .poll = fanotify_poll,
238 .read = fanotify_read,
52c923dd
EP
239 .fasync = NULL,
240 .release = fanotify_release,
a1014f10
EP
241 .unlocked_ioctl = fanotify_ioctl,
242 .compat_ioctl = fanotify_ioctl,
52c923dd
EP
243};
244
2a3edf86
EP
245static void fanotify_free_mark(struct fsnotify_mark *fsn_mark)
246{
247 kmem_cache_free(fanotify_mark_cache, fsn_mark);
248}
249
250static int fanotify_find_path(int dfd, const char __user *filename,
251 struct path *path, unsigned int flags)
252{
253 int ret;
254
255 pr_debug("%s: dfd=%d filename=%p flags=%x\n", __func__,
256 dfd, filename, flags);
257
258 if (filename == NULL) {
259 struct file *file;
260 int fput_needed;
261
262 ret = -EBADF;
263 file = fget_light(dfd, &fput_needed);
264 if (!file)
265 goto out;
266
267 ret = -ENOTDIR;
268 if ((flags & FAN_MARK_ONLYDIR) &&
269 !(S_ISDIR(file->f_path.dentry->d_inode->i_mode))) {
270 fput_light(file, fput_needed);
271 goto out;
272 }
273
274 *path = file->f_path;
275 path_get(path);
276 fput_light(file, fput_needed);
277 } else {
278 unsigned int lookup_flags = 0;
279
280 if (!(flags & FAN_MARK_DONT_FOLLOW))
281 lookup_flags |= LOOKUP_FOLLOW;
282 if (flags & FAN_MARK_ONLYDIR)
283 lookup_flags |= LOOKUP_DIRECTORY;
284
285 ret = user_path_at(dfd, filename, lookup_flags, path);
286 if (ret)
287 goto out;
288 }
289
290 /* you can only watch an inode if you have read permissions on it */
291 ret = inode_permission(path->dentry->d_inode, MAY_READ);
292 if (ret)
293 path_put(path);
294out:
295 return ret;
296}
297
88826276
EP
298static void fanotify_update_object_mask(struct fsnotify_group *group,
299 struct inode *inode,
300 struct vfsmount *mnt,
301 struct fsnotify_mark *fsn_mark,
302 unsigned int flags,
303 __u32 mask)
2a3edf86 304{
88826276 305 __u32 old_mask, new_mask;
2a3edf86 306
88826276
EP
307 pr_debug("%s: group=%p inode=%p mnt=%p fsn_mark=%p flags=%x mask=%x\n",
308 __func__, group, inode, mnt, fsn_mark, flags, mask);
2a3edf86
EP
309
310 spin_lock(&fsn_mark->lock);
88826276
EP
311 old_mask = fsn_mark->mask;
312 if (flags & FAN_MARK_ADD)
313 fsn_mark->mask |= mask;
314 else if (flags & FAN_MARK_REMOVE)
315 fsn_mark->mask &= ~mask;
316 else
317 BUG();
2a3edf86
EP
318 new_mask = fsn_mark->mask;
319 spin_unlock(&fsn_mark->lock);
320
321 if (!new_mask)
322 fsnotify_destroy_mark(fsn_mark);
88826276
EP
323
324 /* we made changes to a mask, update the group mask and the object mask
325 * so things happen quickly. */
326 if (old_mask != new_mask) {
327 __u32 dropped, do_object, do_group;
328
329 /* more bits in old than in new? */
330 dropped = (old_mask & ~new_mask);
331 /* more bits in this fsn_mark than the group? */
332 do_group = (new_mask & ~group->mask);
333
334 if (inode) {
335 /* more bits in this fsn_mark than the object's mask? */
336 do_object = (new_mask & ~inode->i_fsnotify_mask);
337 /* update the object with this new fsn_mark */
338 if (dropped || do_object)
339 fsnotify_recalc_inode_mask(inode);
340 } else if (mnt) {
341 /* more bits in this fsn_mark than the object's mask? */
342 do_object = (new_mask & ~mnt->mnt_fsnotify_mask);
343 /* update the object with this new fsn_mark */
344 if (dropped || do_object)
345 fsnotify_recalc_vfsmount_mask(mnt);
346 } else {
347 BUG();
348 }
349
350 /* update the group mask with the new mask */
351 if (dropped || do_group)
352 fsnotify_recalc_group_mask(group);
353 }
354}
355
356static int fanotify_remove_mark(struct fsnotify_group *group, struct inode *inode,
357 struct vfsmount *mnt, unsigned int flags, __u32 mask)
358{
359 struct fsnotify_mark *fsn_mark = NULL;
360
361 BUG_ON(inode && mnt);
362 BUG_ON(!inode && !mnt);
363
364 if (inode)
365 fsn_mark = fsnotify_find_inode_mark(group, inode);
366 else if (mnt)
367 fsn_mark = fsnotify_find_vfsmount_mark(group, mnt);
2a3edf86 368 else
88826276 369 BUG();
2a3edf86 370
88826276
EP
371 if (!fsn_mark)
372 return -ENOENT;
373
374 fanotify_update_object_mask(group, inode, mnt, fsn_mark, flags, mask);
2a3edf86 375
5444e298 376 /* matches the fsnotify_find_inode_mark() */
2a3edf86
EP
377 fsnotify_put_mark(fsn_mark);
378
379 return 0;
380}
381
88826276
EP
382static struct fsnotify_mark *fanotify_add_vfsmount_mark(struct fsnotify_group *group,
383 struct vfsmount *mnt)
2a3edf86
EP
384{
385 struct fsnotify_mark *fsn_mark;
2a3edf86 386
88826276
EP
387 fsn_mark = fsnotify_find_vfsmount_mark(group, mnt);
388 if (!fsn_mark) {
389 struct fsnotify_mark *new_fsn_mark;
390 int ret;
391
392 fsn_mark = ERR_PTR(-ENOMEM);
393 new_fsn_mark = kmem_cache_alloc(fanotify_mark_cache, GFP_KERNEL);
394 if (!new_fsn_mark)
395 goto out;
396
397 fsnotify_init_mark(new_fsn_mark, fanotify_free_mark);
398 ret = fsnotify_add_mark(new_fsn_mark, group, NULL, mnt, 0);
399 if (ret) {
400 fsn_mark = ERR_PTR(ret);
401 fanotify_free_mark(new_fsn_mark);
402 goto out;
403 }
404
405 fsn_mark = new_fsn_mark;
406 }
407out:
408 return fsn_mark;
409}
410
411static struct fsnotify_mark *fanotify_add_inode_mark(struct fsnotify_group *group,
412 struct inode *inode)
413{
414 struct fsnotify_mark *fsn_mark;
415
416 pr_debug("%s: group=%p inode=%p\n", __func__, group, inode);
2a3edf86 417
5444e298 418 fsn_mark = fsnotify_find_inode_mark(group, inode);
2a3edf86
EP
419 if (!fsn_mark) {
420 struct fsnotify_mark *new_fsn_mark;
88826276 421 int ret;
2a3edf86 422
88826276 423 fsn_mark = ERR_PTR(-ENOMEM);
2a3edf86
EP
424 new_fsn_mark = kmem_cache_alloc(fanotify_mark_cache, GFP_KERNEL);
425 if (!new_fsn_mark)
426 goto out;
427
428 fsnotify_init_mark(new_fsn_mark, fanotify_free_mark);
5444e298 429 ret = fsnotify_add_mark(new_fsn_mark, group, inode, NULL, 0);
2a3edf86 430 if (ret) {
88826276 431 fsn_mark = ERR_PTR(ret);
2a3edf86
EP
432 fanotify_free_mark(new_fsn_mark);
433 goto out;
434 }
435
436 fsn_mark = new_fsn_mark;
437 }
88826276
EP
438out:
439 return fsn_mark;
440}
2a3edf86 441
88826276
EP
442static int fanotify_add_mark(struct fsnotify_group *group, struct inode *inode,
443 struct vfsmount *mnt, unsigned int flags, __u32 mask)
444{
445 struct fsnotify_mark *fsn_mark;
2a3edf86 446
88826276
EP
447 pr_debug("%s: group=%p inode=%p mnt=%p flags=%x mask=%x\n",
448 __func__, group, inode, mnt, flags, mask);
2a3edf86 449
88826276
EP
450 BUG_ON(inode && mnt);
451 BUG_ON(!inode && !mnt);
2a3edf86 452
88826276
EP
453 if (inode)
454 fsn_mark = fanotify_add_inode_mark(group, inode);
455 else if (mnt)
456 fsn_mark = fanotify_add_vfsmount_mark(group, mnt);
457 else
458 BUG();
2a3edf86 459
88826276
EP
460 if (IS_ERR(fsn_mark))
461 goto out;
462
463 fanotify_update_object_mask(group, inode, mnt, fsn_mark, flags, mask);
2a3edf86
EP
464
465 /* match the init or the find.... */
466 fsnotify_put_mark(fsn_mark);
467out:
88826276 468 return PTR_ERR(fsn_mark);
2a3edf86
EP
469}
470
471static int fanotify_update_mark(struct fsnotify_group *group,
88826276
EP
472 struct inode *inode, struct vfsmount *mnt,
473 int flags, __u32 mask)
2a3edf86 474{
88826276
EP
475 pr_debug("%s: group=%p inode=%p mnt=%p flags=%x mask=%x\n",
476 __func__, group, inode, mnt, flags, mask);
477
478 BUG_ON(inode && mnt);
479 BUG_ON(!inode && !mnt);
2a3edf86
EP
480
481 if (flags & FAN_MARK_ADD)
88826276 482 fanotify_add_mark(group, inode, mnt, flags, mask);
2a3edf86 483 else if (flags & FAN_MARK_REMOVE)
88826276 484 fanotify_remove_mark(group, inode, mnt, flags, mask);
2a3edf86
EP
485 else
486 BUG();
487
488 return 0;
489}
490
491static bool fanotify_mark_validate_input(int flags,
492 __u32 mask)
493{
494 pr_debug("%s: flags=%x mask=%x\n", __func__, flags, mask);
495
496 /* are flags valid of this operation? */
497 if (!fanotify_mark_flags_valid(flags))
498 return false;
499 /* is the mask valid? */
500 if (!fanotify_mask_valid(mask))
501 return false;
502 return true;
503}
504
52c923dd 505/* fanotify syscalls */
11637e4b
EP
506SYSCALL_DEFINE3(fanotify_init, unsigned int, flags, unsigned int, event_f_flags,
507 unsigned int, priority)
508{
52c923dd
EP
509 struct fsnotify_group *group;
510 int f_flags, fd;
511
512 pr_debug("%s: flags=%d event_f_flags=%d priority=%d\n",
513 __func__, flags, event_f_flags, priority);
514
515 if (event_f_flags)
516 return -EINVAL;
517 if (priority)
518 return -EINVAL;
519
520 if (!capable(CAP_SYS_ADMIN))
521 return -EACCES;
522
523 if (flags & ~FAN_ALL_INIT_FLAGS)
524 return -EINVAL;
525
526 f_flags = (O_RDONLY | FMODE_NONOTIFY);
527 if (flags & FAN_CLOEXEC)
528 f_flags |= O_CLOEXEC;
529 if (flags & FAN_NONBLOCK)
530 f_flags |= O_NONBLOCK;
531
532 /* fsnotify_alloc_group takes a ref. Dropped in fanotify_release */
533 group = fsnotify_alloc_group(&fanotify_fsnotify_ops);
534 if (IS_ERR(group))
535 return PTR_ERR(group);
536
537 fd = anon_inode_getfd("[fanotify]", &fanotify_fops, group, f_flags);
538 if (fd < 0)
539 goto out_put_group;
540
541 return fd;
542
543out_put_group:
544 fsnotify_put_group(group);
545 return fd;
11637e4b 546}
bbaa4168 547
9bbfc964
HC
548SYSCALL_DEFINE(fanotify_mark)(int fanotify_fd, unsigned int flags,
549 __u64 mask, int dfd,
550 const char __user * pathname)
bbaa4168 551{
2a3edf86
EP
552 struct inode *inode;
553 struct fsnotify_group *group;
554 struct file *filp;
555 struct path path;
556 int ret, fput_needed;
557
558 pr_debug("%s: fanotify_fd=%d flags=%x dfd=%d pathname=%p mask=%llx\n",
559 __func__, fanotify_fd, flags, dfd, pathname, mask);
560
561 /* we only use the lower 32 bits as of right now. */
562 if (mask & ((__u64)0xffffffff << 32))
563 return -EINVAL;
564
565 if (!fanotify_mark_validate_input(flags, mask))
566 return -EINVAL;
567
568 filp = fget_light(fanotify_fd, &fput_needed);
569 if (unlikely(!filp))
570 return -EBADF;
571
572 /* verify that this is indeed an fanotify instance */
573 ret = -EINVAL;
574 if (unlikely(filp->f_op != &fanotify_fops))
575 goto fput_and_out;
576
577 ret = fanotify_find_path(dfd, pathname, &path, flags);
578 if (ret)
579 goto fput_and_out;
580
581 /* inode held in place by reference to path; group by fget on fd */
582 inode = path.dentry->d_inode;
583 group = filp->private_data;
584
585 /* create/update an inode mark */
88826276 586 ret = fanotify_update_mark(group, inode, NULL, flags, mask);
2a3edf86
EP
587
588 path_put(&path);
589fput_and_out:
590 fput_light(filp, fput_needed);
591 return ret;
592}
593
9bbfc964
HC
594#ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
595asmlinkage long SyS_fanotify_mark(long fanotify_fd, long flags, __u64 mask,
596 long dfd, long pathname)
597{
598 return SYSC_fanotify_mark((int) fanotify_fd, (unsigned int) flags,
599 mask, (int) dfd,
600 (const char __user *) pathname);
601}
602SYSCALL_ALIAS(sys_fanotify_mark, SyS_fanotify_mark);
603#endif
604
2a3edf86
EP
605/*
606 * fanotify_user_setup - Our initialization function. Note that we cannnot return
607 * error because we have compiled-in VFS hooks. So an (unlikely) failure here
608 * must result in panic().
609 */
610static int __init fanotify_user_setup(void)
611{
612 fanotify_mark_cache = KMEM_CACHE(fsnotify_mark, SLAB_PANIC);
613
614 return 0;
bbaa4168 615}
2a3edf86 616device_initcall(fanotify_user_setup);