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