[PATCH] inotify (2/5): add name's inode to event handler
[linux-2.6.git] / fs / inotify_user.c
1 /*
2  * fs/inotify_user.c - inotify support for userspace
3  *
4  * Authors:
5  *      John McCutchan  <ttb@tentacle.dhs.org>
6  *      Robert Love     <rml@novell.com>
7  *
8  * Copyright (C) 2005 John McCutchan
9  * Copyright 2006 Hewlett-Packard Development Company, L.P.
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU General Public License as published by the
13  * Free Software Foundation; either version 2, or (at your option) any
14  * later version.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  */
21
22 #include <linux/kernel.h>
23 #include <linux/sched.h>
24 #include <linux/slab.h>
25 #include <linux/fs.h>
26 #include <linux/file.h>
27 #include <linux/mount.h>
28 #include <linux/namei.h>
29 #include <linux/poll.h>
30 #include <linux/init.h>
31 #include <linux/list.h>
32 #include <linux/inotify.h>
33 #include <linux/syscalls.h>
34
35 #include <asm/ioctls.h>
36
37 static kmem_cache_t *watch_cachep __read_mostly;
38 static kmem_cache_t *event_cachep __read_mostly;
39
40 static struct vfsmount *inotify_mnt __read_mostly;
41
42 /* these are configurable via /proc/sys/fs/inotify/ */
43 int inotify_max_user_instances __read_mostly;
44 int inotify_max_user_watches __read_mostly;
45 int inotify_max_queued_events __read_mostly;
46
47 /*
48  * Lock ordering:
49  *
50  * inotify_dev->up_mutex (ensures we don't re-add the same watch)
51  *      inode->inotify_mutex (protects inode's watch list)
52  *              inotify_handle->mutex (protects inotify_handle's watch list)
53  *                      inotify_dev->ev_mutex (protects device's event queue)
54  */
55
56 /*
57  * Lifetimes of the main data structures:
58  *
59  * inotify_device: Lifetime is managed by reference count, from
60  * sys_inotify_init() until release.  Additional references can bump the count
61  * via get_inotify_dev() and drop the count via put_inotify_dev().
62  *
63  * inotify_user_watch: Lifetime is from create_watch() to the receipt of an
64  * IN_IGNORED event from inotify, or when using IN_ONESHOT, to receipt of the
65  * first event, or to inotify_destroy().
66  */
67
68 /*
69  * struct inotify_device - represents an inotify instance
70  *
71  * This structure is protected by the mutex 'mutex'.
72  */
73 struct inotify_device {
74         wait_queue_head_t       wq;             /* wait queue for i/o */
75         struct mutex            ev_mutex;       /* protects event queue */
76         struct mutex            up_mutex;       /* synchronizes watch updates */
77         struct list_head        events;         /* list of queued events */
78         atomic_t                count;          /* reference count */
79         struct user_struct      *user;          /* user who opened this dev */
80         struct inotify_handle   *ih;            /* inotify handle */
81         unsigned int            queue_size;     /* size of the queue (bytes) */
82         unsigned int            event_count;    /* number of pending events */
83         unsigned int            max_events;     /* maximum number of events */
84 };
85
86 /*
87  * struct inotify_kernel_event - An inotify event, originating from a watch and
88  * queued for user-space.  A list of these is attached to each instance of the
89  * device.  In read(), this list is walked and all events that can fit in the
90  * buffer are returned.
91  *
92  * Protected by dev->ev_mutex of the device in which we are queued.
93  */
94 struct inotify_kernel_event {
95         struct inotify_event    event;  /* the user-space event */
96         struct list_head        list;   /* entry in inotify_device's list */
97         char                    *name;  /* filename, if any */
98 };
99
100 /*
101  * struct inotify_user_watch - our version of an inotify_watch, we add
102  * a reference to the associated inotify_device.
103  */
104 struct inotify_user_watch {
105         struct inotify_device   *dev;   /* associated device */
106         struct inotify_watch    wdata;  /* inotify watch data */
107 };
108
109 #ifdef CONFIG_SYSCTL
110
111 #include <linux/sysctl.h>
112
113 static int zero;
114
115 ctl_table inotify_table[] = {
116         {
117                 .ctl_name       = INOTIFY_MAX_USER_INSTANCES,
118                 .procname       = "max_user_instances",
119                 .data           = &inotify_max_user_instances,
120                 .maxlen         = sizeof(int),
121                 .mode           = 0644,
122                 .proc_handler   = &proc_dointvec_minmax,
123                 .strategy       = &sysctl_intvec,
124                 .extra1         = &zero,
125         },
126         {
127                 .ctl_name       = INOTIFY_MAX_USER_WATCHES,
128                 .procname       = "max_user_watches",
129                 .data           = &inotify_max_user_watches,
130                 .maxlen         = sizeof(int),
131                 .mode           = 0644,
132                 .proc_handler   = &proc_dointvec_minmax,
133                 .strategy       = &sysctl_intvec,
134                 .extra1         = &zero,
135         },
136         {
137                 .ctl_name       = INOTIFY_MAX_QUEUED_EVENTS,
138                 .procname       = "max_queued_events",
139                 .data           = &inotify_max_queued_events,
140                 .maxlen         = sizeof(int),
141                 .mode           = 0644,
142                 .proc_handler   = &proc_dointvec_minmax,
143                 .strategy       = &sysctl_intvec,
144                 .extra1         = &zero
145         },
146         { .ctl_name = 0 }
147 };
148 #endif /* CONFIG_SYSCTL */
149
150 static inline void get_inotify_dev(struct inotify_device *dev)
151 {
152         atomic_inc(&dev->count);
153 }
154
155 static inline void put_inotify_dev(struct inotify_device *dev)
156 {
157         if (atomic_dec_and_test(&dev->count)) {
158                 atomic_dec(&dev->user->inotify_devs);
159                 free_uid(dev->user);
160                 kfree(dev);
161         }
162 }
163
164 /*
165  * free_inotify_user_watch - cleans up the watch and its references
166  */
167 static void free_inotify_user_watch(struct inotify_watch *w)
168 {
169         struct inotify_user_watch *watch;
170         struct inotify_device *dev;
171
172         watch = container_of(w, struct inotify_user_watch, wdata);
173         dev = watch->dev;
174
175         atomic_dec(&dev->user->inotify_watches);
176         put_inotify_dev(dev);
177         kmem_cache_free(watch_cachep, watch);
178 }
179
180 /*
181  * kernel_event - create a new kernel event with the given parameters
182  *
183  * This function can sleep.
184  */
185 static struct inotify_kernel_event * kernel_event(s32 wd, u32 mask, u32 cookie,
186                                                   const char *name)
187 {
188         struct inotify_kernel_event *kevent;
189
190         kevent = kmem_cache_alloc(event_cachep, GFP_KERNEL);
191         if (unlikely(!kevent))
192                 return NULL;
193
194         /* we hand this out to user-space, so zero it just in case */
195         memset(&kevent->event, 0, sizeof(struct inotify_event));
196
197         kevent->event.wd = wd;
198         kevent->event.mask = mask;
199         kevent->event.cookie = cookie;
200
201         INIT_LIST_HEAD(&kevent->list);
202
203         if (name) {
204                 size_t len, rem, event_size = sizeof(struct inotify_event);
205
206                 /*
207                  * We need to pad the filename so as to properly align an
208                  * array of inotify_event structures.  Because the structure is
209                  * small and the common case is a small filename, we just round
210                  * up to the next multiple of the structure's sizeof.  This is
211                  * simple and safe for all architectures.
212                  */
213                 len = strlen(name) + 1;
214                 rem = event_size - len;
215                 if (len > event_size) {
216                         rem = event_size - (len % event_size);
217                         if (len % event_size == 0)
218                                 rem = 0;
219                 }
220
221                 kevent->name = kmalloc(len + rem, GFP_KERNEL);
222                 if (unlikely(!kevent->name)) {
223                         kmem_cache_free(event_cachep, kevent);
224                         return NULL;
225                 }
226                 memcpy(kevent->name, name, len);
227                 if (rem)
228                         memset(kevent->name + len, 0, rem);
229                 kevent->event.len = len + rem;
230         } else {
231                 kevent->event.len = 0;
232                 kevent->name = NULL;
233         }
234
235         return kevent;
236 }
237
238 /*
239  * inotify_dev_get_event - return the next event in the given dev's queue
240  *
241  * Caller must hold dev->ev_mutex.
242  */
243 static inline struct inotify_kernel_event *
244 inotify_dev_get_event(struct inotify_device *dev)
245 {
246         return list_entry(dev->events.next, struct inotify_kernel_event, list);
247 }
248
249 /*
250  * inotify_dev_queue_event - event handler registered with core inotify, adds
251  * a new event to the given device
252  *
253  * Can sleep (calls kernel_event()).
254  */
255 static void inotify_dev_queue_event(struct inotify_watch *w, u32 wd, u32 mask,
256                                     u32 cookie, const char *name,
257                                     struct inode *ignored)
258 {
259         struct inotify_user_watch *watch;
260         struct inotify_device *dev;
261         struct inotify_kernel_event *kevent, *last;
262
263         watch = container_of(w, struct inotify_user_watch, wdata);
264         dev = watch->dev;
265
266         mutex_lock(&dev->ev_mutex);
267
268         /* we can safely put the watch as we don't reference it while
269          * generating the event
270          */
271         if (mask & IN_IGNORED || mask & IN_ONESHOT)
272                 put_inotify_watch(w); /* final put */
273
274         /* coalescing: drop this event if it is a dupe of the previous */
275         last = inotify_dev_get_event(dev);
276         if (last && last->event.mask == mask && last->event.wd == wd &&
277                         last->event.cookie == cookie) {
278                 const char *lastname = last->name;
279
280                 if (!name && !lastname)
281                         goto out;
282                 if (name && lastname && !strcmp(lastname, name))
283                         goto out;
284         }
285
286         /* the queue overflowed and we already sent the Q_OVERFLOW event */
287         if (unlikely(dev->event_count > dev->max_events))
288                 goto out;
289
290         /* if the queue overflows, we need to notify user space */
291         if (unlikely(dev->event_count == dev->max_events))
292                 kevent = kernel_event(-1, IN_Q_OVERFLOW, cookie, NULL);
293         else
294                 kevent = kernel_event(wd, mask, cookie, name);
295
296         if (unlikely(!kevent))
297                 goto out;
298
299         /* queue the event and wake up anyone waiting */
300         dev->event_count++;
301         dev->queue_size += sizeof(struct inotify_event) + kevent->event.len;
302         list_add_tail(&kevent->list, &dev->events);
303         wake_up_interruptible(&dev->wq);
304
305 out:
306         mutex_unlock(&dev->ev_mutex);
307 }
308
309 /*
310  * remove_kevent - cleans up and ultimately frees the given kevent
311  *
312  * Caller must hold dev->ev_mutex.
313  */
314 static void remove_kevent(struct inotify_device *dev,
315                           struct inotify_kernel_event *kevent)
316 {
317         list_del(&kevent->list);
318
319         dev->event_count--;
320         dev->queue_size -= sizeof(struct inotify_event) + kevent->event.len;
321
322         kfree(kevent->name);
323         kmem_cache_free(event_cachep, kevent);
324 }
325
326 /*
327  * inotify_dev_event_dequeue - destroy an event on the given device
328  *
329  * Caller must hold dev->ev_mutex.
330  */
331 static void inotify_dev_event_dequeue(struct inotify_device *dev)
332 {
333         if (!list_empty(&dev->events)) {
334                 struct inotify_kernel_event *kevent;
335                 kevent = inotify_dev_get_event(dev);
336                 remove_kevent(dev, kevent);
337         }
338 }
339
340 /*
341  * find_inode - resolve a user-given path to a specific inode and return a nd
342  */
343 static int find_inode(const char __user *dirname, struct nameidata *nd,
344                       unsigned flags)
345 {
346         int error;
347
348         error = __user_walk(dirname, flags, nd);
349         if (error)
350                 return error;
351         /* you can only watch an inode if you have read permissions on it */
352         error = vfs_permission(nd, MAY_READ);
353         if (error)
354                 path_release(nd);
355         return error;
356 }
357
358 /*
359  * create_watch - creates a watch on the given device.
360  *
361  * Callers must hold dev->up_mutex.
362  */
363 static int create_watch(struct inotify_device *dev, struct inode *inode,
364                         u32 mask)
365 {
366         struct inotify_user_watch *watch;
367         int ret;
368
369         if (atomic_read(&dev->user->inotify_watches) >=
370                         inotify_max_user_watches)
371                 return -ENOSPC;
372
373         watch = kmem_cache_alloc(watch_cachep, GFP_KERNEL);
374         if (unlikely(!watch))
375                 return -ENOMEM;
376
377         /* save a reference to device and bump the count to make it official */
378         get_inotify_dev(dev);
379         watch->dev = dev;
380
381         atomic_inc(&dev->user->inotify_watches);
382
383         ret = inotify_add_watch(dev->ih, &watch->wdata, inode, mask);
384         if (ret < 0)
385                 free_inotify_user_watch(&watch->wdata);
386
387         return ret;
388 }
389
390 /* Device Interface */
391
392 static unsigned int inotify_poll(struct file *file, poll_table *wait)
393 {
394         struct inotify_device *dev = file->private_data;
395         int ret = 0;
396
397         poll_wait(file, &dev->wq, wait);
398         mutex_lock(&dev->ev_mutex);
399         if (!list_empty(&dev->events))
400                 ret = POLLIN | POLLRDNORM;
401         mutex_unlock(&dev->ev_mutex);
402
403         return ret;
404 }
405
406 static ssize_t inotify_read(struct file *file, char __user *buf,
407                             size_t count, loff_t *pos)
408 {
409         size_t event_size = sizeof (struct inotify_event);
410         struct inotify_device *dev;
411         char __user *start;
412         int ret;
413         DEFINE_WAIT(wait);
414
415         start = buf;
416         dev = file->private_data;
417
418         while (1) {
419                 int events;
420
421                 prepare_to_wait(&dev->wq, &wait, TASK_INTERRUPTIBLE);
422
423                 mutex_lock(&dev->ev_mutex);
424                 events = !list_empty(&dev->events);
425                 mutex_unlock(&dev->ev_mutex);
426                 if (events) {
427                         ret = 0;
428                         break;
429                 }
430
431                 if (file->f_flags & O_NONBLOCK) {
432                         ret = -EAGAIN;
433                         break;
434                 }
435
436                 if (signal_pending(current)) {
437                         ret = -EINTR;
438                         break;
439                 }
440
441                 schedule();
442         }
443
444         finish_wait(&dev->wq, &wait);
445         if (ret)
446                 return ret;
447
448         mutex_lock(&dev->ev_mutex);
449         while (1) {
450                 struct inotify_kernel_event *kevent;
451
452                 ret = buf - start;
453                 if (list_empty(&dev->events))
454                         break;
455
456                 kevent = inotify_dev_get_event(dev);
457                 if (event_size + kevent->event.len > count)
458                         break;
459
460                 if (copy_to_user(buf, &kevent->event, event_size)) {
461                         ret = -EFAULT;
462                         break;
463                 }
464                 buf += event_size;
465                 count -= event_size;
466
467                 if (kevent->name) {
468                         if (copy_to_user(buf, kevent->name, kevent->event.len)){
469                                 ret = -EFAULT;
470                                 break;
471                         }
472                         buf += kevent->event.len;
473                         count -= kevent->event.len;
474                 }
475
476                 remove_kevent(dev, kevent);
477         }
478         mutex_unlock(&dev->ev_mutex);
479
480         return ret;
481 }
482
483 static int inotify_release(struct inode *ignored, struct file *file)
484 {
485         struct inotify_device *dev = file->private_data;
486
487         inotify_destroy(dev->ih);
488
489         /* destroy all of the events on this device */
490         mutex_lock(&dev->ev_mutex);
491         while (!list_empty(&dev->events))
492                 inotify_dev_event_dequeue(dev);
493         mutex_unlock(&dev->ev_mutex);
494
495         /* free this device: the put matching the get in inotify_init() */
496         put_inotify_dev(dev);
497
498         return 0;
499 }
500
501 static long inotify_ioctl(struct file *file, unsigned int cmd,
502                           unsigned long arg)
503 {
504         struct inotify_device *dev;
505         void __user *p;
506         int ret = -ENOTTY;
507
508         dev = file->private_data;
509         p = (void __user *) arg;
510
511         switch (cmd) {
512         case FIONREAD:
513                 ret = put_user(dev->queue_size, (int __user *) p);
514                 break;
515         }
516
517         return ret;
518 }
519
520 static const struct file_operations inotify_fops = {
521         .poll           = inotify_poll,
522         .read           = inotify_read,
523         .release        = inotify_release,
524         .unlocked_ioctl = inotify_ioctl,
525         .compat_ioctl   = inotify_ioctl,
526 };
527
528 static const struct inotify_operations inotify_user_ops = {
529         .handle_event   = inotify_dev_queue_event,
530         .destroy_watch  = free_inotify_user_watch,
531 };
532
533 asmlinkage long sys_inotify_init(void)
534 {
535         struct inotify_device *dev;
536         struct inotify_handle *ih;
537         struct user_struct *user;
538         struct file *filp;
539         int fd, ret;
540
541         fd = get_unused_fd();
542         if (fd < 0)
543                 return fd;
544
545         filp = get_empty_filp();
546         if (!filp) {
547                 ret = -ENFILE;
548                 goto out_put_fd;
549         }
550
551         user = get_uid(current->user);
552         if (unlikely(atomic_read(&user->inotify_devs) >=
553                         inotify_max_user_instances)) {
554                 ret = -EMFILE;
555                 goto out_free_uid;
556         }
557
558         dev = kmalloc(sizeof(struct inotify_device), GFP_KERNEL);
559         if (unlikely(!dev)) {
560                 ret = -ENOMEM;
561                 goto out_free_uid;
562         }
563
564         ih = inotify_init(&inotify_user_ops);
565         if (unlikely(IS_ERR(ih))) {
566                 ret = PTR_ERR(ih);
567                 goto out_free_dev;
568         }
569         dev->ih = ih;
570
571         filp->f_op = &inotify_fops;
572         filp->f_vfsmnt = mntget(inotify_mnt);
573         filp->f_dentry = dget(inotify_mnt->mnt_root);
574         filp->f_mapping = filp->f_dentry->d_inode->i_mapping;
575         filp->f_mode = FMODE_READ;
576         filp->f_flags = O_RDONLY;
577         filp->private_data = dev;
578
579         INIT_LIST_HEAD(&dev->events);
580         init_waitqueue_head(&dev->wq);
581         mutex_init(&dev->ev_mutex);
582         mutex_init(&dev->up_mutex);
583         dev->event_count = 0;
584         dev->queue_size = 0;
585         dev->max_events = inotify_max_queued_events;
586         dev->user = user;
587         atomic_set(&dev->count, 0);
588
589         get_inotify_dev(dev);
590         atomic_inc(&user->inotify_devs);
591         fd_install(fd, filp);
592
593         return fd;
594 out_free_dev:
595         kfree(dev);
596 out_free_uid:
597         free_uid(user);
598         put_filp(filp);
599 out_put_fd:
600         put_unused_fd(fd);
601         return ret;
602 }
603
604 asmlinkage long sys_inotify_add_watch(int fd, const char __user *path, u32 mask)
605 {
606         struct inode *inode;
607         struct inotify_device *dev;
608         struct nameidata nd;
609         struct file *filp;
610         int ret, fput_needed;
611         unsigned flags = 0;
612
613         filp = fget_light(fd, &fput_needed);
614         if (unlikely(!filp))
615                 return -EBADF;
616
617         /* verify that this is indeed an inotify instance */
618         if (unlikely(filp->f_op != &inotify_fops)) {
619                 ret = -EINVAL;
620                 goto fput_and_out;
621         }
622
623         if (!(mask & IN_DONT_FOLLOW))
624                 flags |= LOOKUP_FOLLOW;
625         if (mask & IN_ONLYDIR)
626                 flags |= LOOKUP_DIRECTORY;
627
628         ret = find_inode(path, &nd, flags);
629         if (unlikely(ret))
630                 goto fput_and_out;
631
632         /* inode held in place by reference to nd; dev by fget on fd */
633         inode = nd.dentry->d_inode;
634         dev = filp->private_data;
635
636         mutex_lock(&dev->up_mutex);
637         ret = inotify_find_update_watch(dev->ih, inode, mask);
638         if (ret == -ENOENT)
639                 ret = create_watch(dev, inode, mask);
640         mutex_unlock(&dev->up_mutex);
641
642         path_release(&nd);
643 fput_and_out:
644         fput_light(filp, fput_needed);
645         return ret;
646 }
647
648 asmlinkage long sys_inotify_rm_watch(int fd, u32 wd)
649 {
650         struct file *filp;
651         struct inotify_device *dev;
652         int ret, fput_needed;
653
654         filp = fget_light(fd, &fput_needed);
655         if (unlikely(!filp))
656                 return -EBADF;
657
658         /* verify that this is indeed an inotify instance */
659         if (unlikely(filp->f_op != &inotify_fops)) {
660                 ret = -EINVAL;
661                 goto out;
662         }
663
664         dev = filp->private_data;
665
666         /* we free our watch data when we get IN_IGNORED */
667         ret = inotify_rm_wd(dev->ih, wd);
668
669 out:
670         fput_light(filp, fput_needed);
671         return ret;
672 }
673
674 static struct super_block *
675 inotify_get_sb(struct file_system_type *fs_type, int flags,
676                const char *dev_name, void *data)
677 {
678     return get_sb_pseudo(fs_type, "inotify", NULL, 0xBAD1DEA);
679 }
680
681 static struct file_system_type inotify_fs_type = {
682     .name           = "inotifyfs",
683     .get_sb         = inotify_get_sb,
684     .kill_sb        = kill_anon_super,
685 };
686
687 /*
688  * inotify_user_setup - Our initialization function.  Note that we cannnot return
689  * error because we have compiled-in VFS hooks.  So an (unlikely) failure here
690  * must result in panic().
691  */
692 static int __init inotify_user_setup(void)
693 {
694         int ret;
695
696         ret = register_filesystem(&inotify_fs_type);
697         if (unlikely(ret))
698                 panic("inotify: register_filesystem returned %d!\n", ret);
699
700         inotify_mnt = kern_mount(&inotify_fs_type);
701         if (IS_ERR(inotify_mnt))
702                 panic("inotify: kern_mount ret %ld!\n", PTR_ERR(inotify_mnt));
703
704         inotify_max_queued_events = 16384;
705         inotify_max_user_instances = 128;
706         inotify_max_user_watches = 8192;
707
708         watch_cachep = kmem_cache_create("inotify_watch_cache",
709                                          sizeof(struct inotify_user_watch),
710                                          0, SLAB_PANIC, NULL, NULL);
711         event_cachep = kmem_cache_create("inotify_event_cache",
712                                          sizeof(struct inotify_kernel_event),
713                                          0, SLAB_PANIC, NULL, NULL);
714
715         return 0;
716 }
717
718 module_init(inotify_user_setup);