blob: 6a0ba2c858e6a4ee471d8e76361fb87210c85f74 [file] [log] [blame]
Robert Love0eeca282005-07-12 17:06:03 -04001/*
2 * fs/inotify.c - inode-based file event notifications
3 *
4 * Authors:
5 * John McCutchan <ttb@tentacle.dhs.org>
6 * Robert Love <rml@novell.com>
7 *
8 * Copyright (C) 2005 John McCutchan
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2, or (at your option) any
13 * later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 */
20
21#include <linux/module.h>
22#include <linux/kernel.h>
23#include <linux/sched.h>
24#include <linux/spinlock.h>
25#include <linux/idr.h>
26#include <linux/slab.h>
27#include <linux/fs.h>
28#include <linux/file.h>
29#include <linux/mount.h>
30#include <linux/namei.h>
31#include <linux/poll.h>
Robert Love0eeca282005-07-12 17:06:03 -040032#include <linux/init.h>
33#include <linux/list.h>
34#include <linux/writeback.h>
35#include <linux/inotify.h>
36
37#include <asm/ioctls.h>
38
39static atomic_t inotify_cookie;
40
41static kmem_cache_t *watch_cachep;
42static kmem_cache_t *event_cachep;
43
44static struct vfsmount *inotify_mnt;
45
Robert Love0399cb02005-07-13 12:38:18 -040046/* these are configurable via /proc/sys/fs/inotify/ */
47int inotify_max_user_instances;
Robert Love0eeca282005-07-12 17:06:03 -040048int inotify_max_user_watches;
49int inotify_max_queued_events;
50
51/*
52 * Lock ordering:
53 *
54 * dentry->d_lock (used to keep d_move() away from dentry->d_parent)
55 * iprune_sem (synchronize shrink_icache_memory())
56 * inode_lock (protects the super_block->s_inodes list)
57 * inode->inotify_sem (protects inode->inotify_watches and watches->i_list)
58 * inotify_dev->sem (protects inotify_device and watches->d_list)
59 */
60
61/*
62 * Lifetimes of the three main data structures--inotify_device, inode, and
63 * inotify_watch--are managed by reference count.
64 *
Robert Loveb6807162005-07-25 15:07:13 -040065 * inotify_device: Lifetime is from inotify_init() until release. Additional
66 * references can bump the count via get_inotify_dev() and drop the count via
Robert Love0eeca282005-07-12 17:06:03 -040067 * put_inotify_dev().
68 *
69 * inotify_watch: Lifetime is from create_watch() to destory_watch().
70 * Additional references can bump the count via get_inotify_watch() and drop
71 * the count via put_inotify_watch().
72 *
73 * inode: Pinned so long as the inode is associated with a watch, from
74 * create_watch() to put_inotify_watch().
75 */
76
77/*
Robert Loveb6807162005-07-25 15:07:13 -040078 * struct inotify_device - represents an inotify instance
Robert Love0eeca282005-07-12 17:06:03 -040079 *
80 * This structure is protected by the semaphore 'sem'.
81 */
82struct inotify_device {
83 wait_queue_head_t wq; /* wait queue for i/o */
84 struct idr idr; /* idr mapping wd -> watch */
85 struct semaphore sem; /* protects this bad boy */
86 struct list_head events; /* list of queued events */
87 struct list_head watches; /* list of watches */
88 atomic_t count; /* reference count */
89 struct user_struct *user; /* user who opened this dev */
90 unsigned int queue_size; /* size of the queue (bytes) */
91 unsigned int event_count; /* number of pending events */
92 unsigned int max_events; /* maximum number of events */
93};
94
95/*
96 * struct inotify_kernel_event - An inotify event, originating from a watch and
97 * queued for user-space. A list of these is attached to each instance of the
98 * device. In read(), this list is walked and all events that can fit in the
99 * buffer are returned.
100 *
101 * Protected by dev->sem of the device in which we are queued.
102 */
103struct inotify_kernel_event {
104 struct inotify_event event; /* the user-space event */
105 struct list_head list; /* entry in inotify_device's list */
106 char *name; /* filename, if any */
107};
108
109/*
110 * struct inotify_watch - represents a watch request on a specific inode
111 *
112 * d_list is protected by dev->sem of the associated watch->dev.
113 * i_list and mask are protected by inode->inotify_sem of the associated inode.
114 * dev, inode, and wd are never written to once the watch is created.
115 */
116struct inotify_watch {
117 struct list_head d_list; /* entry in inotify_device's list */
118 struct list_head i_list; /* entry in inode's list */
119 atomic_t count; /* reference count */
120 struct inotify_device *dev; /* associated device */
121 struct inode *inode; /* associated inode */
122 s32 wd; /* watch descriptor */
123 u32 mask; /* event mask for this watch */
124};
125
Robert Love0399cb02005-07-13 12:38:18 -0400126#ifdef CONFIG_SYSCTL
127
128#include <linux/sysctl.h>
129
130static int zero;
131
132ctl_table inotify_table[] = {
133 {
134 .ctl_name = INOTIFY_MAX_USER_INSTANCES,
135 .procname = "max_user_instances",
136 .data = &inotify_max_user_instances,
137 .maxlen = sizeof(int),
138 .mode = 0644,
139 .proc_handler = &proc_dointvec_minmax,
140 .strategy = &sysctl_intvec,
141 .extra1 = &zero,
142 },
143 {
144 .ctl_name = INOTIFY_MAX_USER_WATCHES,
145 .procname = "max_user_watches",
146 .data = &inotify_max_user_watches,
147 .maxlen = sizeof(int),
148 .mode = 0644,
149 .proc_handler = &proc_dointvec_minmax,
150 .strategy = &sysctl_intvec,
151 .extra1 = &zero,
152 },
153 {
154 .ctl_name = INOTIFY_MAX_QUEUED_EVENTS,
155 .procname = "max_queued_events",
156 .data = &inotify_max_queued_events,
157 .maxlen = sizeof(int),
158 .mode = 0644,
159 .proc_handler = &proc_dointvec_minmax,
160 .strategy = &sysctl_intvec,
161 .extra1 = &zero
162 },
163 { .ctl_name = 0 }
164};
165#endif /* CONFIG_SYSCTL */
166
Robert Love0eeca282005-07-12 17:06:03 -0400167static inline void get_inotify_dev(struct inotify_device *dev)
168{
169 atomic_inc(&dev->count);
170}
171
172static inline void put_inotify_dev(struct inotify_device *dev)
173{
174 if (atomic_dec_and_test(&dev->count)) {
175 atomic_dec(&dev->user->inotify_devs);
176 free_uid(dev->user);
177 kfree(dev);
178 }
179}
180
181static inline void get_inotify_watch(struct inotify_watch *watch)
182{
183 atomic_inc(&watch->count);
184}
185
186/*
187 * put_inotify_watch - decrements the ref count on a given watch. cleans up
188 * the watch and its references if the count reaches zero.
189 */
190static inline void put_inotify_watch(struct inotify_watch *watch)
191{
192 if (atomic_dec_and_test(&watch->count)) {
193 put_inotify_dev(watch->dev);
194 iput(watch->inode);
195 kmem_cache_free(watch_cachep, watch);
196 }
197}
198
199/*
200 * kernel_event - create a new kernel event with the given parameters
201 *
202 * This function can sleep.
203 */
204static struct inotify_kernel_event * kernel_event(s32 wd, u32 mask, u32 cookie,
205 const char *name)
206{
207 struct inotify_kernel_event *kevent;
208
209 kevent = kmem_cache_alloc(event_cachep, GFP_KERNEL);
210 if (unlikely(!kevent))
211 return NULL;
212
213 /* we hand this out to user-space, so zero it just in case */
214 memset(&kevent->event, 0, sizeof(struct inotify_event));
215
216 kevent->event.wd = wd;
217 kevent->event.mask = mask;
218 kevent->event.cookie = cookie;
219
220 INIT_LIST_HEAD(&kevent->list);
221
222 if (name) {
223 size_t len, rem, event_size = sizeof(struct inotify_event);
224
225 /*
226 * We need to pad the filename so as to properly align an
227 * array of inotify_event structures. Because the structure is
228 * small and the common case is a small filename, we just round
229 * up to the next multiple of the structure's sizeof. This is
230 * simple and safe for all architectures.
231 */
232 len = strlen(name) + 1;
233 rem = event_size - len;
234 if (len > event_size) {
235 rem = event_size - (len % event_size);
236 if (len % event_size == 0)
237 rem = 0;
238 }
239
240 kevent->name = kmalloc(len + rem, GFP_KERNEL);
241 if (unlikely(!kevent->name)) {
242 kmem_cache_free(event_cachep, kevent);
243 return NULL;
244 }
245 memcpy(kevent->name, name, len);
246 if (rem)
247 memset(kevent->name + len, 0, rem);
248 kevent->event.len = len + rem;
249 } else {
250 kevent->event.len = 0;
251 kevent->name = NULL;
252 }
253
254 return kevent;
255}
256
257/*
258 * inotify_dev_get_event - return the next event in the given dev's queue
259 *
260 * Caller must hold dev->sem.
261 */
262static inline struct inotify_kernel_event *
263inotify_dev_get_event(struct inotify_device *dev)
264{
265 return list_entry(dev->events.next, struct inotify_kernel_event, list);
266}
267
268/*
269 * inotify_dev_queue_event - add a new event to the given device
270 *
271 * Caller must hold dev->sem. Can sleep (calls kernel_event()).
272 */
273static void inotify_dev_queue_event(struct inotify_device *dev,
274 struct inotify_watch *watch, u32 mask,
275 u32 cookie, const char *name)
276{
277 struct inotify_kernel_event *kevent, *last;
278
279 /* coalescing: drop this event if it is a dupe of the previous */
280 last = inotify_dev_get_event(dev);
281 if (last && last->event.mask == mask && last->event.wd == watch->wd &&
282 last->event.cookie == cookie) {
283 const char *lastname = last->name;
284
285 if (!name && !lastname)
286 return;
287 if (name && lastname && !strcmp(lastname, name))
288 return;
289 }
290
291 /* the queue overflowed and we already sent the Q_OVERFLOW event */
292 if (unlikely(dev->event_count > dev->max_events))
293 return;
294
295 /* if the queue overflows, we need to notify user space */
296 if (unlikely(dev->event_count == dev->max_events))
297 kevent = kernel_event(-1, IN_Q_OVERFLOW, cookie, NULL);
298 else
299 kevent = kernel_event(watch->wd, mask, cookie, name);
300
301 if (unlikely(!kevent))
302 return;
303
304 /* queue the event and wake up anyone waiting */
305 dev->event_count++;
306 dev->queue_size += sizeof(struct inotify_event) + kevent->event.len;
307 list_add_tail(&kevent->list, &dev->events);
308 wake_up_interruptible(&dev->wq);
309}
310
311/*
312 * remove_kevent - cleans up and ultimately frees the given kevent
313 *
314 * Caller must hold dev->sem.
315 */
316static void remove_kevent(struct inotify_device *dev,
317 struct inotify_kernel_event *kevent)
318{
319 list_del(&kevent->list);
320
321 dev->event_count--;
322 dev->queue_size -= sizeof(struct inotify_event) + kevent->event.len;
323
324 kfree(kevent->name);
325 kmem_cache_free(event_cachep, kevent);
326}
327
328/*
329 * inotify_dev_event_dequeue - destroy an event on the given device
330 *
331 * Caller must hold dev->sem.
332 */
333static void inotify_dev_event_dequeue(struct inotify_device *dev)
334{
335 if (!list_empty(&dev->events)) {
336 struct inotify_kernel_event *kevent;
337 kevent = inotify_dev_get_event(dev);
338 remove_kevent(dev, kevent);
339 }
340}
341
342/*
343 * inotify_dev_get_wd - returns the next WD for use by the given dev
344 *
345 * Callers must hold dev->sem. This function can sleep.
346 */
347static int inotify_dev_get_wd(struct inotify_device *dev,
348 struct inotify_watch *watch)
349{
350 int ret;
351
352 do {
353 if (unlikely(!idr_pre_get(&dev->idr, GFP_KERNEL)))
354 return -ENOSPC;
355 ret = idr_get_new(&dev->idr, watch, &watch->wd);
356 } while (ret == -EAGAIN);
357
358 return ret;
359}
360
361/*
362 * find_inode - resolve a user-given path to a specific inode and return a nd
363 */
364static int find_inode(const char __user *dirname, struct nameidata *nd)
365{
366 int error;
367
368 error = __user_walk(dirname, LOOKUP_FOLLOW, nd);
369 if (error)
370 return error;
371 /* you can only watch an inode if you have read permissions on it */
372 error = permission(nd->dentry->d_inode, MAY_READ, NULL);
373 if (error)
Robert Loveb6807162005-07-25 15:07:13 -0400374 path_release(nd);
Robert Love0eeca282005-07-12 17:06:03 -0400375 return error;
376}
377
378/*
379 * create_watch - creates a watch on the given device.
380 *
381 * Callers must hold dev->sem. Calls inotify_dev_get_wd() so may sleep.
382 * Both 'dev' and 'inode' (by way of nameidata) need to be pinned.
383 */
384static struct inotify_watch *create_watch(struct inotify_device *dev,
385 u32 mask, struct inode *inode)
386{
387 struct inotify_watch *watch;
388 int ret;
389
Robert Loveb6807162005-07-25 15:07:13 -0400390 if (atomic_read(&dev->user->inotify_watches) >=
391 inotify_max_user_watches)
Robert Love0eeca282005-07-12 17:06:03 -0400392 return ERR_PTR(-ENOSPC);
393
394 watch = kmem_cache_alloc(watch_cachep, GFP_KERNEL);
395 if (unlikely(!watch))
396 return ERR_PTR(-ENOMEM);
397
398 ret = inotify_dev_get_wd(dev, watch);
399 if (unlikely(ret)) {
400 kmem_cache_free(watch_cachep, watch);
401 return ERR_PTR(ret);
402 }
403
404 watch->mask = mask;
405 atomic_set(&watch->count, 0);
406 INIT_LIST_HEAD(&watch->d_list);
407 INIT_LIST_HEAD(&watch->i_list);
408
409 /* save a reference to device and bump the count to make it official */
410 get_inotify_dev(dev);
411 watch->dev = dev;
412
413 /*
414 * Save a reference to the inode and bump the ref count to make it
415 * official. We hold a reference to nameidata, which makes this safe.
416 */
417 watch->inode = igrab(inode);
418
419 /* bump our own count, corresponding to our entry in dev->watches */
420 get_inotify_watch(watch);
421
422 atomic_inc(&dev->user->inotify_watches);
423
424 return watch;
425}
426
427/*
428 * inotify_find_dev - find the watch associated with the given inode and dev
429 *
430 * Callers must hold inode->inotify_sem.
431 */
432static struct inotify_watch *inode_find_dev(struct inode *inode,
433 struct inotify_device *dev)
434{
435 struct inotify_watch *watch;
436
437 list_for_each_entry(watch, &inode->inotify_watches, i_list) {
438 if (watch->dev == dev)
439 return watch;
440 }
441
442 return NULL;
443}
444
445/*
446 * remove_watch_no_event - remove_watch() without the IN_IGNORED event.
447 */
448static void remove_watch_no_event(struct inotify_watch *watch,
449 struct inotify_device *dev)
450{
451 list_del(&watch->i_list);
452 list_del(&watch->d_list);
453
454 atomic_dec(&dev->user->inotify_watches);
455 idr_remove(&dev->idr, watch->wd);
456 put_inotify_watch(watch);
457}
458
459/*
460 * remove_watch - Remove a watch from both the device and the inode. Sends
461 * the IN_IGNORED event to the given device signifying that the inode is no
462 * longer watched.
463 *
464 * Callers must hold both inode->inotify_sem and dev->sem. We drop a
465 * reference to the inode before returning.
466 *
467 * The inode is not iput() so as to remain atomic. If the inode needs to be
468 * iput(), the call returns one. Otherwise, it returns zero.
469 */
470static void remove_watch(struct inotify_watch *watch,struct inotify_device *dev)
471{
472 inotify_dev_queue_event(dev, watch, IN_IGNORED, 0, NULL);
473 remove_watch_no_event(watch, dev);
474}
475
476/*
477 * inotify_inode_watched - returns nonzero if there are watches on this inode
478 * and zero otherwise. We call this lockless, we do not care if we race.
479 */
480static inline int inotify_inode_watched(struct inode *inode)
481{
482 return !list_empty(&inode->inotify_watches);
483}
484
485/* Kernel API */
486
487/**
488 * inotify_inode_queue_event - queue an event to all watches on this inode
489 * @inode: inode event is originating from
490 * @mask: event mask describing this event
491 * @cookie: cookie for synchronization, or zero
492 * @name: filename, if any
493 */
494void inotify_inode_queue_event(struct inode *inode, u32 mask, u32 cookie,
495 const char *name)
496{
497 struct inotify_watch *watch, *next;
498
499 if (!inotify_inode_watched(inode))
500 return;
501
502 down(&inode->inotify_sem);
503 list_for_each_entry_safe(watch, next, &inode->inotify_watches, i_list) {
504 u32 watch_mask = watch->mask;
505 if (watch_mask & mask) {
506 struct inotify_device *dev = watch->dev;
507 get_inotify_watch(watch);
508 down(&dev->sem);
509 inotify_dev_queue_event(dev, watch, mask, cookie, name);
510 if (watch_mask & IN_ONESHOT)
511 remove_watch_no_event(watch, dev);
512 up(&dev->sem);
513 put_inotify_watch(watch);
514 }
515 }
516 up(&inode->inotify_sem);
517}
518EXPORT_SYMBOL_GPL(inotify_inode_queue_event);
519
520/**
521 * inotify_dentry_parent_queue_event - queue an event to a dentry's parent
522 * @dentry: the dentry in question, we queue against this dentry's parent
523 * @mask: event mask describing this event
524 * @cookie: cookie for synchronization, or zero
525 * @name: filename, if any
526 */
527void inotify_dentry_parent_queue_event(struct dentry *dentry, u32 mask,
528 u32 cookie, const char *name)
529{
530 struct dentry *parent;
531 struct inode *inode;
532
533 spin_lock(&dentry->d_lock);
534 parent = dentry->d_parent;
535 inode = parent->d_inode;
536
537 if (inotify_inode_watched(inode)) {
538 dget(parent);
539 spin_unlock(&dentry->d_lock);
540 inotify_inode_queue_event(inode, mask, cookie, name);
541 dput(parent);
542 } else
543 spin_unlock(&dentry->d_lock);
544}
545EXPORT_SYMBOL_GPL(inotify_dentry_parent_queue_event);
546
547/**
548 * inotify_get_cookie - return a unique cookie for use in synchronizing events.
549 */
550u32 inotify_get_cookie(void)
551{
552 return atomic_inc_return(&inotify_cookie);
553}
554EXPORT_SYMBOL_GPL(inotify_get_cookie);
555
556/**
557 * inotify_unmount_inodes - an sb is unmounting. handle any watched inodes.
558 * @list: list of inodes being unmounted (sb->s_inodes)
559 *
560 * Called with inode_lock held, protecting the unmounting super block's list
561 * of inodes, and with iprune_sem held, keeping shrink_icache_memory() at bay.
562 * We temporarily drop inode_lock, however, and CAN block.
563 */
564void inotify_unmount_inodes(struct list_head *list)
565{
566 struct inode *inode, *next_i, *need_iput = NULL;
567
568 list_for_each_entry_safe(inode, next_i, list, i_sb_list) {
569 struct inotify_watch *watch, *next_w;
570 struct inode *need_iput_tmp;
571 struct list_head *watches;
572
573 /*
574 * If i_count is zero, the inode cannot have any watches and
575 * doing an __iget/iput with MS_ACTIVE clear would actually
576 * evict all inodes with zero i_count from icache which is
577 * unnecessarily violent and may in fact be illegal to do.
578 */
579 if (!atomic_read(&inode->i_count))
580 continue;
581
582 /*
583 * We cannot __iget() an inode in state I_CLEAR, I_FREEING, or
584 * I_WILL_FREE which is fine because by that point the inode
585 * cannot have any associated watches.
586 */
587 if (inode->i_state & (I_CLEAR | I_FREEING | I_WILL_FREE))
588 continue;
589
590 need_iput_tmp = need_iput;
591 need_iput = NULL;
592 /* In case the remove_watch() drops a reference. */
593 if (inode != need_iput_tmp)
594 __iget(inode);
595 else
596 need_iput_tmp = NULL;
597 /* In case the dropping of a reference would nuke next_i. */
598 if ((&next_i->i_sb_list != list) &&
599 atomic_read(&next_i->i_count) &&
600 !(next_i->i_state & (I_CLEAR | I_FREEING |
601 I_WILL_FREE))) {
602 __iget(next_i);
603 need_iput = next_i;
604 }
605
606 /*
607 * We can safely drop inode_lock here because we hold
608 * references on both inode and next_i. Also no new inodes
609 * will be added since the umount has begun. Finally,
610 * iprune_sem keeps shrink_icache_memory() away.
611 */
612 spin_unlock(&inode_lock);
613
614 if (need_iput_tmp)
615 iput(need_iput_tmp);
616
617 /* for each watch, send IN_UNMOUNT and then remove it */
618 down(&inode->inotify_sem);
619 watches = &inode->inotify_watches;
620 list_for_each_entry_safe(watch, next_w, watches, i_list) {
621 struct inotify_device *dev = watch->dev;
622 down(&dev->sem);
623 inotify_dev_queue_event(dev, watch, IN_UNMOUNT,0,NULL);
624 remove_watch(watch, dev);
625 up(&dev->sem);
626 }
627 up(&inode->inotify_sem);
628 iput(inode);
629
630 spin_lock(&inode_lock);
631 }
632}
633EXPORT_SYMBOL_GPL(inotify_unmount_inodes);
634
635/**
636 * inotify_inode_is_dead - an inode has been deleted, cleanup any watches
637 * @inode: inode that is about to be removed
638 */
639void inotify_inode_is_dead(struct inode *inode)
640{
641 struct inotify_watch *watch, *next;
642
643 down(&inode->inotify_sem);
644 list_for_each_entry_safe(watch, next, &inode->inotify_watches, i_list) {
645 struct inotify_device *dev = watch->dev;
646 down(&dev->sem);
647 remove_watch(watch, dev);
648 up(&dev->sem);
649 }
650 up(&inode->inotify_sem);
651}
652EXPORT_SYMBOL_GPL(inotify_inode_is_dead);
653
654/* Device Interface */
655
656static unsigned int inotify_poll(struct file *file, poll_table *wait)
657{
658 struct inotify_device *dev = file->private_data;
659 int ret = 0;
660
661 poll_wait(file, &dev->wq, wait);
662 down(&dev->sem);
663 if (!list_empty(&dev->events))
664 ret = POLLIN | POLLRDNORM;
665 up(&dev->sem);
666
667 return ret;
668}
669
670static ssize_t inotify_read(struct file *file, char __user *buf,
671 size_t count, loff_t *pos)
672{
673 size_t event_size = sizeof (struct inotify_event);
674 struct inotify_device *dev;
675 char __user *start;
676 int ret;
677 DEFINE_WAIT(wait);
678
679 start = buf;
680 dev = file->private_data;
681
682 while (1) {
683 int events;
684
685 prepare_to_wait(&dev->wq, &wait, TASK_INTERRUPTIBLE);
686
687 down(&dev->sem);
688 events = !list_empty(&dev->events);
689 up(&dev->sem);
690 if (events) {
691 ret = 0;
692 break;
693 }
694
695 if (file->f_flags & O_NONBLOCK) {
696 ret = -EAGAIN;
697 break;
698 }
699
700 if (signal_pending(current)) {
701 ret = -EINTR;
702 break;
703 }
704
705 schedule();
706 }
707
708 finish_wait(&dev->wq, &wait);
709 if (ret)
710 return ret;
711
712 down(&dev->sem);
713 while (1) {
714 struct inotify_kernel_event *kevent;
715
716 ret = buf - start;
717 if (list_empty(&dev->events))
718 break;
719
720 kevent = inotify_dev_get_event(dev);
721 if (event_size + kevent->event.len > count)
722 break;
723
724 if (copy_to_user(buf, &kevent->event, event_size)) {
725 ret = -EFAULT;
726 break;
727 }
728 buf += event_size;
729 count -= event_size;
730
731 if (kevent->name) {
732 if (copy_to_user(buf, kevent->name, kevent->event.len)){
733 ret = -EFAULT;
734 break;
735 }
736 buf += kevent->event.len;
737 count -= kevent->event.len;
738 }
739
740 remove_kevent(dev, kevent);
741 }
742 up(&dev->sem);
743
744 return ret;
745}
746
747static int inotify_release(struct inode *ignored, struct file *file)
748{
749 struct inotify_device *dev = file->private_data;
750
751 /*
752 * Destroy all of the watches on this device. Unfortunately, not very
753 * pretty. We cannot do a simple iteration over the list, because we
754 * do not know the inode until we iterate to the watch. But we need to
755 * hold inode->inotify_sem before dev->sem. The following works.
756 */
757 while (1) {
758 struct inotify_watch *watch;
759 struct list_head *watches;
760 struct inode *inode;
761
762 down(&dev->sem);
763 watches = &dev->watches;
764 if (list_empty(watches)) {
765 up(&dev->sem);
766 break;
767 }
768 watch = list_entry(watches->next, struct inotify_watch, d_list);
769 get_inotify_watch(watch);
770 up(&dev->sem);
771
772 inode = watch->inode;
773 down(&inode->inotify_sem);
774 down(&dev->sem);
775 remove_watch_no_event(watch, dev);
776 up(&dev->sem);
777 up(&inode->inotify_sem);
778 put_inotify_watch(watch);
779 }
780
781 /* destroy all of the events on this device */
782 down(&dev->sem);
783 while (!list_empty(&dev->events))
784 inotify_dev_event_dequeue(dev);
785 up(&dev->sem);
786
Robert Loveb6807162005-07-25 15:07:13 -0400787 /* free this device: the put matching the get in inotify_init() */
Robert Love0eeca282005-07-12 17:06:03 -0400788 put_inotify_dev(dev);
789
790 return 0;
791}
792
793/*
Robert Loveb6807162005-07-25 15:07:13 -0400794 * inotify_ignore - remove a given wd from this inotify instance.
Robert Love0eeca282005-07-12 17:06:03 -0400795 *
796 * Can sleep.
797 */
798static int inotify_ignore(struct inotify_device *dev, s32 wd)
799{
800 struct inotify_watch *watch;
801 struct inode *inode;
802
803 down(&dev->sem);
804 watch = idr_find(&dev->idr, wd);
805 if (unlikely(!watch)) {
806 up(&dev->sem);
807 return -EINVAL;
808 }
809 get_inotify_watch(watch);
810 inode = watch->inode;
811 up(&dev->sem);
812
813 down(&inode->inotify_sem);
814 down(&dev->sem);
815
816 /* make sure that we did not race */
817 watch = idr_find(&dev->idr, wd);
818 if (likely(watch))
819 remove_watch(watch, dev);
820
821 up(&dev->sem);
822 up(&inode->inotify_sem);
823 put_inotify_watch(watch);
824
825 return 0;
826}
827
828static long inotify_ioctl(struct file *file, unsigned int cmd,
829 unsigned long arg)
830{
831 struct inotify_device *dev;
832 void __user *p;
833 int ret = -ENOTTY;
834
835 dev = file->private_data;
836 p = (void __user *) arg;
837
838 switch (cmd) {
839 case FIONREAD:
840 ret = put_user(dev->queue_size, (int __user *) p);
841 break;
842 }
843
844 return ret;
845}
846
847static struct file_operations inotify_fops = {
848 .poll = inotify_poll,
849 .read = inotify_read,
850 .release = inotify_release,
851 .unlocked_ioctl = inotify_ioctl,
852 .compat_ioctl = inotify_ioctl,
853};
854
855asmlinkage long sys_inotify_init(void)
856{
857 struct inotify_device *dev;
858 struct user_struct *user;
Robert Loveb6807162005-07-25 15:07:13 -0400859 struct file *filp;
860 int fd, ret;
Robert Love0eeca282005-07-12 17:06:03 -0400861
862 fd = get_unused_fd();
Robert Loveb6807162005-07-25 15:07:13 -0400863 if (fd < 0)
864 return fd;
Robert Love0eeca282005-07-12 17:06:03 -0400865
866 filp = get_empty_filp();
867 if (!filp) {
Robert Love0eeca282005-07-12 17:06:03 -0400868 ret = -ENFILE;
Robert Love5eb22cb2005-07-25 15:12:19 -0400869 goto out_put_fd;
Robert Love0eeca282005-07-12 17:06:03 -0400870 }
Robert Love0eeca282005-07-12 17:06:03 -0400871
872 user = get_uid(current->user);
Robert Loveb6807162005-07-25 15:07:13 -0400873 if (unlikely(atomic_read(&user->inotify_devs) >=
874 inotify_max_user_instances)) {
Robert Love0eeca282005-07-12 17:06:03 -0400875 ret = -EMFILE;
Robert Love5eb22cb2005-07-25 15:12:19 -0400876 goto out_free_uid;
Robert Love0eeca282005-07-12 17:06:03 -0400877 }
878
879 dev = kmalloc(sizeof(struct inotify_device), GFP_KERNEL);
880 if (unlikely(!dev)) {
881 ret = -ENOMEM;
Robert Love5eb22cb2005-07-25 15:12:19 -0400882 goto out_free_uid;
Robert Love0eeca282005-07-12 17:06:03 -0400883 }
884
Robert Loveb6807162005-07-25 15:07:13 -0400885 filp->f_op = &inotify_fops;
886 filp->f_vfsmnt = mntget(inotify_mnt);
887 filp->f_dentry = dget(inotify_mnt->mnt_root);
888 filp->f_mapping = filp->f_dentry->d_inode->i_mapping;
889 filp->f_mode = FMODE_READ;
890 filp->f_flags = O_RDONLY;
891 filp->private_data = dev;
892
Robert Love0eeca282005-07-12 17:06:03 -0400893 idr_init(&dev->idr);
894 INIT_LIST_HEAD(&dev->events);
895 INIT_LIST_HEAD(&dev->watches);
896 init_waitqueue_head(&dev->wq);
897 sema_init(&dev->sem, 1);
898 dev->event_count = 0;
899 dev->queue_size = 0;
900 dev->max_events = inotify_max_queued_events;
901 dev->user = user;
902 atomic_set(&dev->count, 0);
903
904 get_inotify_dev(dev);
905 atomic_inc(&user->inotify_devs);
Robert Loveb6807162005-07-25 15:07:13 -0400906 fd_install(fd, filp);
Robert Love0eeca282005-07-12 17:06:03 -0400907
Robert Love0eeca282005-07-12 17:06:03 -0400908 return fd;
Robert Love5eb22cb2005-07-25 15:12:19 -0400909out_free_uid:
Robert Love0eeca282005-07-12 17:06:03 -0400910 free_uid(user);
Robert Love5eb22cb2005-07-25 15:12:19 -0400911 put_filp(filp);
912out_put_fd:
913 put_unused_fd(fd);
Robert Love0eeca282005-07-12 17:06:03 -0400914 return ret;
915}
916
Robert Loveb6807162005-07-25 15:07:13 -0400917asmlinkage long sys_inotify_add_watch(int fd, const char __user *path, u32 mask)
Robert Love0eeca282005-07-12 17:06:03 -0400918{
919 struct inotify_watch *watch, *old;
920 struct inode *inode;
921 struct inotify_device *dev;
922 struct nameidata nd;
923 struct file *filp;
Robert Love33ea2f52005-07-25 15:08:37 -0400924 int ret, fput_needed;
Robert Love0eeca282005-07-12 17:06:03 -0400925
Robert Love33ea2f52005-07-25 15:08:37 -0400926 filp = fget_light(fd, &fput_needed);
927 if (unlikely(!filp))
Robert Love0eeca282005-07-12 17:06:03 -0400928 return -EBADF;
929
Robert Love783bc292005-07-25 15:10:08 -0400930 /* verify that this is indeed an inotify instance */
931 if (unlikely(filp->f_op != &inotify_fops)) {
932 ret = -EINVAL;
933 goto fput_and_out;
934 }
935
Robert Loveb6807162005-07-25 15:07:13 -0400936 ret = find_inode(path, &nd);
937 if (unlikely(ret))
Robert Love0eeca282005-07-12 17:06:03 -0400938 goto fput_and_out;
939
Robert Loveb6807162005-07-25 15:07:13 -0400940 /* inode held in place by reference to nd; dev by fget on fd */
Robert Love0eeca282005-07-12 17:06:03 -0400941 inode = nd.dentry->d_inode;
Robert Loveb6807162005-07-25 15:07:13 -0400942 dev = filp->private_data;
Robert Love0eeca282005-07-12 17:06:03 -0400943
944 down(&inode->inotify_sem);
945 down(&dev->sem);
946
947 /* don't let user-space set invalid bits: we don't want flags set */
948 mask &= IN_ALL_EVENTS;
Robert Loveb6807162005-07-25 15:07:13 -0400949 if (unlikely(!mask)) {
Robert Love0eeca282005-07-12 17:06:03 -0400950 ret = -EINVAL;
951 goto out;
952 }
953
954 /*
955 * Handle the case of re-adding a watch on an (inode,dev) pair that we
956 * are already watching. We just update the mask and return its wd.
957 */
958 old = inode_find_dev(inode, dev);
959 if (unlikely(old)) {
960 old->mask = mask;
961 ret = old->wd;
962 goto out;
963 }
964
965 watch = create_watch(dev, mask, inode);
966 if (unlikely(IS_ERR(watch))) {
967 ret = PTR_ERR(watch);
968 goto out;
969 }
970
971 /* Add the watch to the device's and the inode's list */
972 list_add(&watch->d_list, &dev->watches);
973 list_add(&watch->i_list, &inode->inotify_watches);
974 ret = watch->wd;
975out:
Robert Love0eeca282005-07-12 17:06:03 -0400976 up(&dev->sem);
977 up(&inode->inotify_sem);
Robert Love5eb22cb2005-07-25 15:12:19 -0400978 path_release(&nd);
Robert Love0eeca282005-07-12 17:06:03 -0400979fput_and_out:
Robert Love33ea2f52005-07-25 15:08:37 -0400980 fput_light(filp, fput_needed);
Robert Love0eeca282005-07-12 17:06:03 -0400981 return ret;
982}
983
984asmlinkage long sys_inotify_rm_watch(int fd, u32 wd)
985{
986 struct file *filp;
987 struct inotify_device *dev;
Robert Love33ea2f52005-07-25 15:08:37 -0400988 int ret, fput_needed;
Robert Love0eeca282005-07-12 17:06:03 -0400989
Robert Love33ea2f52005-07-25 15:08:37 -0400990 filp = fget_light(fd, &fput_needed);
991 if (unlikely(!filp))
Robert Love0eeca282005-07-12 17:06:03 -0400992 return -EBADF;
Robert Love783bc292005-07-25 15:10:08 -0400993
994 /* verify that this is indeed an inotify instance */
995 if (unlikely(filp->f_op != &inotify_fops)) {
996 ret = -EINVAL;
997 goto out;
998 }
999
Robert Love0eeca282005-07-12 17:06:03 -04001000 dev = filp->private_data;
Robert Love9a556e82005-07-13 13:49:23 -04001001 ret = inotify_ignore(dev, wd);
Robert Love9a556e82005-07-13 13:49:23 -04001002
Robert Love783bc292005-07-25 15:10:08 -04001003out:
1004 fput_light(filp, fput_needed);
Robert Love0eeca282005-07-12 17:06:03 -04001005 return ret;
1006}
1007
1008static struct super_block *
1009inotify_get_sb(struct file_system_type *fs_type, int flags,
1010 const char *dev_name, void *data)
1011{
1012 return get_sb_pseudo(fs_type, "inotify", NULL, 0xBAD1DEA);
1013}
1014
1015static struct file_system_type inotify_fs_type = {
1016 .name = "inotifyfs",
1017 .get_sb = inotify_get_sb,
1018 .kill_sb = kill_anon_super,
1019};
1020
1021/*
Robert Loveb6807162005-07-25 15:07:13 -04001022 * inotify_setup - Our initialization function. Note that we cannnot return
Robert Love0eeca282005-07-12 17:06:03 -04001023 * error because we have compiled-in VFS hooks. So an (unlikely) failure here
1024 * must result in panic().
1025 */
Robert Loveb6807162005-07-25 15:07:13 -04001026static int __init inotify_setup(void)
Robert Love0eeca282005-07-12 17:06:03 -04001027{
1028 register_filesystem(&inotify_fs_type);
1029 inotify_mnt = kern_mount(&inotify_fs_type);
1030
Robert Love1b2ccf02005-07-25 15:13:43 -04001031 inotify_max_queued_events = 16384;
1032 inotify_max_user_instances = 128;
Robert Love0eeca282005-07-12 17:06:03 -04001033 inotify_max_user_watches = 8192;
1034
1035 atomic_set(&inotify_cookie, 0);
1036
1037 watch_cachep = kmem_cache_create("inotify_watch_cache",
1038 sizeof(struct inotify_watch),
1039 0, SLAB_PANIC, NULL, NULL);
1040 event_cachep = kmem_cache_create("inotify_event_cache",
1041 sizeof(struct inotify_kernel_event),
1042 0, SLAB_PANIC, NULL, NULL);
1043
Robert Love0eeca282005-07-12 17:06:03 -04001044 return 0;
1045}
1046
Robert Loveb6807162005-07-25 15:07:13 -04001047module_init(inotify_setup);