416ba91750a9f68707d720a649b147ccbd7244cd
[sfrench/cifs-2.6.git] / fs / notify / mark.c
1 /*
2  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
3  *
4  *  This program is free software; you can redistribute it and/or modify
5  *  it under the terms of the GNU General Public License as published by
6  *  the Free Software Foundation; either version 2, or (at your option)
7  *  any later version.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program; see the file COPYING.  If not, write to
16  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 /*
20  * fsnotify inode mark locking/lifetime/and refcnting
21  *
22  * REFCNT:
23  * The group->recnt and mark->refcnt tell how many "things" in the kernel
24  * currently are referencing the objects. Both kind of objects typically will
25  * live inside the kernel with a refcnt of 2, one for its creation and one for
26  * the reference a group and a mark hold to each other.
27  * If you are holding the appropriate locks, you can take a reference and the
28  * object itself is guaranteed to survive until the reference is dropped.
29  *
30  * LOCKING:
31  * There are 3 locks involved with fsnotify inode marks and they MUST be taken
32  * in order as follows:
33  *
34  * group->mark_mutex
35  * mark->lock
36  * inode->i_lock
37  *
38  * group->mark_mutex protects the marks_list anchored inside a given group and
39  * each mark is hooked via the g_list.  It also protects the groups private
40  * data (i.e group limits).
41
42  * mark->lock protects the marks attributes like its masks and flags.
43  * Furthermore it protects the access to a reference of the group that the mark
44  * is assigned to as well as the access to a reference of the inode/vfsmount
45  * that is being watched by the mark.
46  *
47  * inode->i_lock protects the i_fsnotify_marks list anchored inside a
48  * given inode and each mark is hooked via the i_list. (and sorta the
49  * free_i_list)
50  *
51  *
52  * LIFETIME:
53  * Inode marks survive between when they are added to an inode and when their
54  * refcnt==0. Marks are also protected by fsnotify_mark_srcu.
55  *
56  * The inode mark can be cleared for a number of different reasons including:
57  * - The inode is unlinked for the last time.  (fsnotify_inode_remove)
58  * - The inode is being evicted from cache. (fsnotify_inode_delete)
59  * - The fs the inode is on is unmounted.  (fsnotify_inode_delete/fsnotify_unmount_inodes)
60  * - Something explicitly requests that it be removed.  (fsnotify_destroy_mark)
61  * - The fsnotify_group associated with the mark is going away and all such marks
62  *   need to be cleaned up. (fsnotify_clear_marks_by_group)
63  *
64  * This has the very interesting property of being able to run concurrently with
65  * any (or all) other directions.
66  */
67
68 #include <linux/fs.h>
69 #include <linux/init.h>
70 #include <linux/kernel.h>
71 #include <linux/kthread.h>
72 #include <linux/module.h>
73 #include <linux/mutex.h>
74 #include <linux/slab.h>
75 #include <linux/spinlock.h>
76 #include <linux/srcu.h>
77
78 #include <linux/atomic.h>
79
80 #include <linux/fsnotify_backend.h>
81 #include "fsnotify.h"
82
83 #define FSNOTIFY_REAPER_DELAY   (1)     /* 1 jiffy */
84
85 struct srcu_struct fsnotify_mark_srcu;
86 struct kmem_cache *fsnotify_mark_connector_cachep;
87
88 static DEFINE_SPINLOCK(destroy_lock);
89 static LIST_HEAD(destroy_list);
90
91 static void fsnotify_mark_destroy_workfn(struct work_struct *work);
92 static DECLARE_DELAYED_WORK(reaper_work, fsnotify_mark_destroy_workfn);
93
94 void fsnotify_get_mark(struct fsnotify_mark *mark)
95 {
96         atomic_inc(&mark->refcnt);
97 }
98
99 void fsnotify_put_mark(struct fsnotify_mark *mark)
100 {
101         if (atomic_dec_and_test(&mark->refcnt)) {
102                 if (mark->group)
103                         fsnotify_put_group(mark->group);
104                 mark->free_mark(mark);
105         }
106 }
107
108 static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
109 {
110         u32 new_mask = 0;
111         struct fsnotify_mark *mark;
112
113         hlist_for_each_entry(mark, &conn->list, obj_list)
114                 new_mask |= mark->mask;
115         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
116                 conn->inode->i_fsnotify_mask = new_mask;
117         else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT)
118                 real_mount(conn->mnt)->mnt_fsnotify_mask = new_mask;
119 }
120
121 /*
122  * Calculate mask of events for a list of marks. The caller must make sure
123  * connector cannot disappear under us (usually by holding a mark->lock or
124  * mark->group->mark_mutex for a mark on this list).
125  */
126 void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
127 {
128         if (!conn)
129                 return;
130
131         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
132                 spin_lock(&conn->inode->i_lock);
133         else
134                 spin_lock(&conn->mnt->mnt_root->d_lock);
135         __fsnotify_recalc_mask(conn);
136         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE) {
137                 spin_unlock(&conn->inode->i_lock);
138                 __fsnotify_update_child_dentry_flags(conn->inode);
139         } else {
140                 spin_unlock(&conn->mnt->mnt_root->d_lock);
141         }
142 }
143
144 static struct inode *fsnotify_detach_from_object(struct fsnotify_mark *mark)
145 {
146         struct fsnotify_mark_connector *conn;
147         struct inode *inode = NULL;
148         spinlock_t *lock;
149
150         conn = mark->connector;
151         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
152                 lock = &conn->inode->i_lock;
153         else
154                 lock = &conn->mnt->mnt_root->d_lock;
155         spin_lock(lock);
156         hlist_del_init_rcu(&mark->obj_list);
157         if (hlist_empty(&conn->list)) {
158                 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
159                         inode = conn->inode;
160         }
161         __fsnotify_recalc_mask(conn);
162         mark->connector = NULL;
163         spin_unlock(lock);
164
165         return inode;
166 }
167
168 /*
169  * Remove mark from inode / vfsmount list, group list, drop inode reference
170  * if we got one.
171  *
172  * Must be called with group->mark_mutex held.
173  */
174 void fsnotify_detach_mark(struct fsnotify_mark *mark)
175 {
176         struct inode *inode = NULL;
177         struct fsnotify_group *group = mark->group;
178
179         BUG_ON(!mutex_is_locked(&group->mark_mutex));
180
181         spin_lock(&mark->lock);
182
183         /* something else already called this function on this mark */
184         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
185                 spin_unlock(&mark->lock);
186                 return;
187         }
188
189         mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
190
191         inode = fsnotify_detach_from_object(mark);
192
193         /*
194          * Note that we didn't update flags telling whether inode cares about
195          * what's happening with children. We update these flags from
196          * __fsnotify_parent() lazily when next event happens on one of our
197          * children.
198          */
199
200         list_del_init(&mark->g_list);
201
202         spin_unlock(&mark->lock);
203
204         if (inode)
205                 iput(inode);
206
207         atomic_dec(&group->num_marks);
208 }
209
210 /*
211  * Prepare mark for freeing and add it to the list of marks prepared for
212  * freeing. The actual freeing must happen after SRCU period ends and the
213  * caller is responsible for this.
214  *
215  * The function returns true if the mark was added to the list of marks for
216  * freeing. The function returns false if someone else has already called
217  * __fsnotify_free_mark() for the mark.
218  */
219 static bool __fsnotify_free_mark(struct fsnotify_mark *mark)
220 {
221         struct fsnotify_group *group = mark->group;
222
223         spin_lock(&mark->lock);
224         /* something else already called this function on this mark */
225         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
226                 spin_unlock(&mark->lock);
227                 return false;
228         }
229         mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
230         spin_unlock(&mark->lock);
231
232         /*
233          * Some groups like to know that marks are being freed.  This is a
234          * callback to the group function to let it know that this mark
235          * is being freed.
236          */
237         if (group->ops->freeing_mark)
238                 group->ops->freeing_mark(mark, group);
239
240         spin_lock(&destroy_lock);
241         list_add(&mark->g_list, &destroy_list);
242         spin_unlock(&destroy_lock);
243
244         return true;
245 }
246
247 /*
248  * Free fsnotify mark. The freeing is actually happening from a workqueue which
249  * first waits for srcu period end. Caller must have a reference to the mark
250  * or be protected by fsnotify_mark_srcu.
251  */
252 void fsnotify_free_mark(struct fsnotify_mark *mark)
253 {
254         if (__fsnotify_free_mark(mark)) {
255                 queue_delayed_work(system_unbound_wq, &reaper_work,
256                                    FSNOTIFY_REAPER_DELAY);
257         }
258 }
259
260 void fsnotify_destroy_mark(struct fsnotify_mark *mark,
261                            struct fsnotify_group *group)
262 {
263         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
264         fsnotify_detach_mark(mark);
265         mutex_unlock(&group->mark_mutex);
266         fsnotify_free_mark(mark);
267 }
268
269 void fsnotify_connector_free(struct fsnotify_mark_connector **connp)
270 {
271         if (*connp) {
272                 kmem_cache_free(fsnotify_mark_connector_cachep, *connp);
273                 *connp = NULL;
274         }
275 }
276
277 void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask)
278 {
279         assert_spin_locked(&mark->lock);
280
281         mark->mask = mask;
282 }
283
284 void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask)
285 {
286         assert_spin_locked(&mark->lock);
287
288         mark->ignored_mask = mask;
289 }
290
291 /*
292  * Sorting function for lists of fsnotify marks.
293  *
294  * Fanotify supports different notification classes (reflected as priority of
295  * notification group). Events shall be passed to notification groups in
296  * decreasing priority order. To achieve this marks in notification lists for
297  * inodes and vfsmounts are sorted so that priorities of corresponding groups
298  * are descending.
299  *
300  * Furthermore correct handling of the ignore mask requires processing inode
301  * and vfsmount marks of each group together. Using the group address as
302  * further sort criterion provides a unique sorting order and thus we can
303  * merge inode and vfsmount lists of marks in linear time and find groups
304  * present in both lists.
305  *
306  * A return value of 1 signifies that b has priority over a.
307  * A return value of 0 signifies that the two marks have to be handled together.
308  * A return value of -1 signifies that a has priority over b.
309  */
310 int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
311 {
312         if (a == b)
313                 return 0;
314         if (!a)
315                 return 1;
316         if (!b)
317                 return -1;
318         if (a->priority < b->priority)
319                 return 1;
320         if (a->priority > b->priority)
321                 return -1;
322         if (a < b)
323                 return 1;
324         return -1;
325 }
326
327 static int fsnotify_attach_connector_to_object(
328                                         struct fsnotify_mark_connector **connp,
329                                         spinlock_t *lock,
330                                         struct inode *inode,
331                                         struct vfsmount *mnt)
332 {
333         struct fsnotify_mark_connector *conn;
334
335         conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
336         if (!conn)
337                 return -ENOMEM;
338         INIT_HLIST_HEAD(&conn->list);
339         if (inode) {
340                 conn->flags = FSNOTIFY_OBJ_TYPE_INODE;
341                 conn->inode = inode;
342         } else {
343                 conn->flags = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
344                 conn->mnt = mnt;
345         }
346         /*
347          * Make sure 'conn' initialization is visible. Matches
348          * lockless_dereference() in fsnotify().
349          */
350         smp_wmb();
351         spin_lock(lock);
352         if (!*connp)
353                 *connp = conn;
354         else
355                 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
356         spin_unlock(lock);
357
358         return 0;
359 }
360
361 /*
362  * Add mark into proper place in given list of marks. These marks may be used
363  * for the fsnotify backend to determine which event types should be delivered
364  * to which group and for which inodes. These marks are ordered according to
365  * priority, highest number first, and then by the group's location in memory.
366  */
367 static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
368                                   struct inode *inode, struct vfsmount *mnt,
369                                   int allow_dups)
370 {
371         struct fsnotify_mark *lmark, *last = NULL;
372         struct fsnotify_mark_connector *conn;
373         struct fsnotify_mark_connector **connp;
374         spinlock_t *lock;
375         int cmp;
376         int err = 0;
377
378         if (WARN_ON(!inode && !mnt))
379                 return -EINVAL;
380         if (inode) {
381                 connp = &inode->i_fsnotify_marks;
382                 lock = &inode->i_lock;
383         } else {
384                 connp = &real_mount(mnt)->mnt_fsnotify_marks;
385                 lock = &mnt->mnt_root->d_lock;
386         }
387
388         if (!*connp) {
389                 err = fsnotify_attach_connector_to_object(connp, lock,
390                                                           inode, mnt);
391                 if (err)
392                         return err;
393         }
394         spin_lock(&mark->lock);
395         spin_lock(lock);
396         conn = *connp;
397
398         /* is mark the first mark? */
399         if (hlist_empty(&conn->list)) {
400                 hlist_add_head_rcu(&mark->obj_list, &conn->list);
401                 if (inode)
402                         __iget(inode);
403                 goto added;
404         }
405
406         /* should mark be in the middle of the current list? */
407         hlist_for_each_entry(lmark, &conn->list, obj_list) {
408                 last = lmark;
409
410                 if ((lmark->group == mark->group) && !allow_dups) {
411                         err = -EEXIST;
412                         goto out_err;
413                 }
414
415                 cmp = fsnotify_compare_groups(lmark->group, mark->group);
416                 if (cmp >= 0) {
417                         hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
418                         goto added;
419                 }
420         }
421
422         BUG_ON(last == NULL);
423         /* mark should be the last entry.  last is the current last entry */
424         hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
425 added:
426         mark->connector = conn;
427 out_err:
428         spin_unlock(lock);
429         spin_unlock(&mark->lock);
430         return err;
431 }
432
433 /*
434  * Attach an initialized mark to a given group and fs object.
435  * These marks may be used for the fsnotify backend to determine which
436  * event types should be delivered to which group.
437  */
438 int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
439                              struct fsnotify_group *group, struct inode *inode,
440                              struct vfsmount *mnt, int allow_dups)
441 {
442         int ret = 0;
443
444         BUG_ON(inode && mnt);
445         BUG_ON(!inode && !mnt);
446         BUG_ON(!mutex_is_locked(&group->mark_mutex));
447
448         /*
449          * LOCKING ORDER!!!!
450          * group->mark_mutex
451          * mark->lock
452          * inode->i_lock
453          */
454         spin_lock(&mark->lock);
455         mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
456
457         fsnotify_get_group(group);
458         mark->group = group;
459         list_add(&mark->g_list, &group->marks_list);
460         atomic_inc(&group->num_marks);
461         fsnotify_get_mark(mark); /* for i_list and g_list */
462         spin_unlock(&mark->lock);
463
464         ret = fsnotify_add_mark_list(mark, inode, mnt, allow_dups);
465         if (ret)
466                 goto err;
467
468         if (mark->mask)
469                 fsnotify_recalc_mask(mark->connector);
470
471         return ret;
472 err:
473         mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
474         list_del_init(&mark->g_list);
475         fsnotify_put_group(group);
476         mark->group = NULL;
477         atomic_dec(&group->num_marks);
478
479         spin_unlock(&mark->lock);
480
481         spin_lock(&destroy_lock);
482         list_add(&mark->g_list, &destroy_list);
483         spin_unlock(&destroy_lock);
484         queue_delayed_work(system_unbound_wq, &reaper_work,
485                                 FSNOTIFY_REAPER_DELAY);
486
487         return ret;
488 }
489
490 int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
491                       struct inode *inode, struct vfsmount *mnt, int allow_dups)
492 {
493         int ret;
494         mutex_lock(&group->mark_mutex);
495         ret = fsnotify_add_mark_locked(mark, group, inode, mnt, allow_dups);
496         mutex_unlock(&group->mark_mutex);
497         return ret;
498 }
499
500 /*
501  * Given a list of marks, find the mark associated with given group. If found
502  * take a reference to that mark and return it, else return NULL.
503  */
504 struct fsnotify_mark *fsnotify_find_mark(struct fsnotify_mark_connector *conn,
505                                          struct fsnotify_group *group)
506 {
507         struct fsnotify_mark *mark;
508         spinlock_t *lock;
509
510         if (!conn)
511                 return NULL;
512
513         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
514                 lock = &conn->inode->i_lock;
515         else
516                 lock = &conn->mnt->mnt_root->d_lock;
517         spin_lock(lock);
518         hlist_for_each_entry(mark, &conn->list, obj_list) {
519                 if (mark->group == group) {
520                         fsnotify_get_mark(mark);
521                         spin_unlock(lock);
522                         return mark;
523                 }
524         }
525         spin_unlock(lock);
526         return NULL;
527 }
528
529 /*
530  * clear any marks in a group in which mark->flags & flags is true
531  */
532 void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group,
533                                          unsigned int flags)
534 {
535         struct fsnotify_mark *lmark, *mark;
536         LIST_HEAD(to_free);
537
538         /*
539          * We have to be really careful here. Anytime we drop mark_mutex, e.g.
540          * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
541          * to_free list so we have to use mark_mutex even when accessing that
542          * list. And freeing mark requires us to drop mark_mutex. So we can
543          * reliably free only the first mark in the list. That's why we first
544          * move marks to free to to_free list in one go and then free marks in
545          * to_free list one by one.
546          */
547         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
548         list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
549                 if (mark->connector->flags & flags)
550                         list_move(&mark->g_list, &to_free);
551         }
552         mutex_unlock(&group->mark_mutex);
553
554         while (1) {
555                 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
556                 if (list_empty(&to_free)) {
557                         mutex_unlock(&group->mark_mutex);
558                         break;
559                 }
560                 mark = list_first_entry(&to_free, struct fsnotify_mark, g_list);
561                 fsnotify_get_mark(mark);
562                 fsnotify_detach_mark(mark);
563                 mutex_unlock(&group->mark_mutex);
564                 fsnotify_free_mark(mark);
565                 fsnotify_put_mark(mark);
566         }
567 }
568
569 /*
570  * Given a group, prepare for freeing all the marks associated with that group.
571  * The marks are attached to the list of marks prepared for destruction, the
572  * caller is responsible for freeing marks in that list after SRCU period has
573  * ended.
574  */
575 void fsnotify_detach_group_marks(struct fsnotify_group *group)
576 {
577         struct fsnotify_mark *mark;
578
579         while (1) {
580                 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
581                 if (list_empty(&group->marks_list)) {
582                         mutex_unlock(&group->mark_mutex);
583                         break;
584                 }
585                 mark = list_first_entry(&group->marks_list,
586                                         struct fsnotify_mark, g_list);
587                 fsnotify_get_mark(mark);
588                 fsnotify_detach_mark(mark);
589                 mutex_unlock(&group->mark_mutex);
590                 __fsnotify_free_mark(mark);
591                 fsnotify_put_mark(mark);
592         }
593 }
594
595 void fsnotify_destroy_marks(struct fsnotify_mark_connector *conn)
596 {
597         struct fsnotify_mark *mark;
598         spinlock_t *lock;
599
600         if (!conn)
601                 return;
602
603         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
604                 lock = &conn->inode->i_lock;
605         else
606                 lock = &conn->mnt->mnt_root->d_lock;
607
608         while (1) {
609                 /*
610                  * We have to be careful since we can race with e.g.
611                  * fsnotify_clear_marks_by_group() and once we drop 'lock',
612                  * mark can get removed from the obj_list and destroyed. But
613                  * we are holding mark reference so mark cannot be freed and
614                  * calling fsnotify_destroy_mark() more than once is fine.
615                  */
616                 spin_lock(lock);
617                 if (hlist_empty(&conn->list)) {
618                         spin_unlock(lock);
619                         break;
620                 }
621                 mark = hlist_entry(conn->list.first, struct fsnotify_mark,
622                                    obj_list);
623                 /*
624                  * We don't update i_fsnotify_mask / mnt_fsnotify_mask here
625                  * since inode / mount is going away anyway. So just remove
626                  * mark from the list.
627                  */
628                 hlist_del_init_rcu(&mark->obj_list);
629                 fsnotify_get_mark(mark);
630                 spin_unlock(lock);
631                 fsnotify_destroy_mark(mark, mark->group);
632                 fsnotify_put_mark(mark);
633         }
634 }
635
636 /*
637  * Nothing fancy, just initialize lists and locks and counters.
638  */
639 void fsnotify_init_mark(struct fsnotify_mark *mark,
640                         void (*free_mark)(struct fsnotify_mark *mark))
641 {
642         memset(mark, 0, sizeof(*mark));
643         spin_lock_init(&mark->lock);
644         atomic_set(&mark->refcnt, 1);
645         mark->free_mark = free_mark;
646 }
647
648 /*
649  * Destroy all marks in destroy_list, waits for SRCU period to finish before
650  * actually freeing marks.
651  */
652 void fsnotify_mark_destroy_list(void)
653 {
654         struct fsnotify_mark *mark, *next;
655         struct list_head private_destroy_list;
656
657         spin_lock(&destroy_lock);
658         /* exchange the list head */
659         list_replace_init(&destroy_list, &private_destroy_list);
660         spin_unlock(&destroy_lock);
661
662         synchronize_srcu(&fsnotify_mark_srcu);
663
664         list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
665                 list_del_init(&mark->g_list);
666                 fsnotify_put_mark(mark);
667         }
668 }
669
670 static void fsnotify_mark_destroy_workfn(struct work_struct *work)
671 {
672         fsnotify_mark_destroy_list();
673 }