fsnotify: Provide framework for dropping SRCU lock in ->handle_event
[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  * mark->connector->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  * mark->connector->lock protects the list of marks anchored inside an
48  * inode / vfsmount and each mark is hooked via the i_list.
49  *
50  * A list of notification marks relating to inode / mnt is contained in
51  * fsnotify_mark_connector. That structure is alive as long as there are any
52  * marks in the list and is also protected by fsnotify_mark_srcu. A mark gets
53  * detached from fsnotify_mark_connector when last reference to the mark is
54  * dropped.  Thus having mark reference is enough to protect mark->connector
55  * pointer and to make sure fsnotify_mark_connector cannot disappear. Also
56  * because we remove mark from g_list before dropping mark reference associated
57  * with that, any mark found through g_list is guaranteed to have
58  * mark->connector set until we drop group->mark_mutex.
59  *
60  * LIFETIME:
61  * Inode marks survive between when they are added to an inode and when their
62  * refcnt==0. Marks are also protected by fsnotify_mark_srcu.
63  *
64  * The inode mark can be cleared for a number of different reasons including:
65  * - The inode is unlinked for the last time.  (fsnotify_inode_remove)
66  * - The inode is being evicted from cache. (fsnotify_inode_delete)
67  * - The fs the inode is on is unmounted.  (fsnotify_inode_delete/fsnotify_unmount_inodes)
68  * - Something explicitly requests that it be removed.  (fsnotify_destroy_mark)
69  * - The fsnotify_group associated with the mark is going away and all such marks
70  *   need to be cleaned up. (fsnotify_clear_marks_by_group)
71  *
72  * This has the very interesting property of being able to run concurrently with
73  * any (or all) other directions.
74  */
75
76 #include <linux/fs.h>
77 #include <linux/init.h>
78 #include <linux/kernel.h>
79 #include <linux/kthread.h>
80 #include <linux/module.h>
81 #include <linux/mutex.h>
82 #include <linux/slab.h>
83 #include <linux/spinlock.h>
84 #include <linux/srcu.h>
85
86 #include <linux/atomic.h>
87
88 #include <linux/fsnotify_backend.h>
89 #include "fsnotify.h"
90
91 #define FSNOTIFY_REAPER_DELAY   (1)     /* 1 jiffy */
92
93 struct srcu_struct fsnotify_mark_srcu;
94 struct kmem_cache *fsnotify_mark_connector_cachep;
95
96 static DEFINE_SPINLOCK(destroy_lock);
97 static LIST_HEAD(destroy_list);
98 static struct fsnotify_mark_connector *connector_destroy_list;
99
100 static void fsnotify_mark_destroy_workfn(struct work_struct *work);
101 static DECLARE_DELAYED_WORK(reaper_work, fsnotify_mark_destroy_workfn);
102
103 static void fsnotify_connector_destroy_workfn(struct work_struct *work);
104 static DECLARE_WORK(connector_reaper_work, fsnotify_connector_destroy_workfn);
105
106 void fsnotify_get_mark(struct fsnotify_mark *mark)
107 {
108         WARN_ON_ONCE(!atomic_read(&mark->refcnt));
109         atomic_inc(&mark->refcnt);
110 }
111
112 /*
113  * Get mark reference when we found the mark via lockless traversal of object
114  * list. Mark can be already removed from the list by now and on its way to be
115  * destroyed once SRCU period ends.
116  */
117 static bool fsnotify_get_mark_safe(struct fsnotify_mark *mark)
118 {
119         return atomic_inc_not_zero(&mark->refcnt);
120 }
121
122 static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
123 {
124         u32 new_mask = 0;
125         struct fsnotify_mark *mark;
126
127         assert_spin_locked(&conn->lock);
128         hlist_for_each_entry(mark, &conn->list, obj_list) {
129                 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)
130                         new_mask |= mark->mask;
131         }
132         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
133                 conn->inode->i_fsnotify_mask = new_mask;
134         else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT)
135                 real_mount(conn->mnt)->mnt_fsnotify_mask = new_mask;
136 }
137
138 /*
139  * Calculate mask of events for a list of marks. The caller must make sure
140  * connector and connector->inode cannot disappear under us.  Callers achieve
141  * this by holding a mark->lock or mark->group->mark_mutex for a mark on this
142  * list.
143  */
144 void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
145 {
146         if (!conn)
147                 return;
148
149         spin_lock(&conn->lock);
150         __fsnotify_recalc_mask(conn);
151         spin_unlock(&conn->lock);
152         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
153                 __fsnotify_update_child_dentry_flags(conn->inode);
154 }
155
156 /* Free all connectors queued for freeing once SRCU period ends */
157 static void fsnotify_connector_destroy_workfn(struct work_struct *work)
158 {
159         struct fsnotify_mark_connector *conn, *free;
160
161         spin_lock(&destroy_lock);
162         conn = connector_destroy_list;
163         connector_destroy_list = NULL;
164         spin_unlock(&destroy_lock);
165
166         synchronize_srcu(&fsnotify_mark_srcu);
167         while (conn) {
168                 free = conn;
169                 conn = conn->destroy_next;
170                 kmem_cache_free(fsnotify_mark_connector_cachep, free);
171         }
172 }
173
174 static struct inode *fsnotify_detach_connector_from_object(
175                                         struct fsnotify_mark_connector *conn)
176 {
177         struct inode *inode = NULL;
178
179         if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE) {
180                 inode = conn->inode;
181                 rcu_assign_pointer(inode->i_fsnotify_marks, NULL);
182                 inode->i_fsnotify_mask = 0;
183                 conn->inode = NULL;
184                 conn->flags &= ~FSNOTIFY_OBJ_TYPE_INODE;
185         } else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
186                 rcu_assign_pointer(real_mount(conn->mnt)->mnt_fsnotify_marks,
187                                    NULL);
188                 real_mount(conn->mnt)->mnt_fsnotify_mask = 0;
189                 conn->mnt = NULL;
190                 conn->flags &= ~FSNOTIFY_OBJ_TYPE_VFSMOUNT;
191         }
192
193         return inode;
194 }
195
196 static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
197 {
198         if (mark->group)
199                 fsnotify_put_group(mark->group);
200         mark->free_mark(mark);
201 }
202
203 void fsnotify_put_mark(struct fsnotify_mark *mark)
204 {
205         struct fsnotify_mark_connector *conn;
206         struct inode *inode = NULL;
207         bool free_conn = false;
208
209         /* Catch marks that were actually never attached to object */
210         if (!mark->connector) {
211                 if (atomic_dec_and_test(&mark->refcnt))
212                         fsnotify_final_mark_destroy(mark);
213                 return;
214         }
215
216         /*
217          * We have to be careful so that traversals of obj_list under lock can
218          * safely grab mark reference.
219          */
220         if (!atomic_dec_and_lock(&mark->refcnt, &mark->connector->lock))
221                 return;
222
223         conn = mark->connector;
224         hlist_del_init_rcu(&mark->obj_list);
225         if (hlist_empty(&conn->list)) {
226                 inode = fsnotify_detach_connector_from_object(conn);
227                 free_conn = true;
228         } else {
229                 __fsnotify_recalc_mask(conn);
230         }
231         mark->connector = NULL;
232         spin_unlock(&conn->lock);
233
234         iput(inode);
235
236         if (free_conn) {
237                 spin_lock(&destroy_lock);
238                 conn->destroy_next = connector_destroy_list;
239                 connector_destroy_list = conn;
240                 spin_unlock(&destroy_lock);
241                 queue_work(system_unbound_wq, &connector_reaper_work);
242         }
243         /*
244          * Note that we didn't update flags telling whether inode cares about
245          * what's happening with children. We update these flags from
246          * __fsnotify_parent() lazily when next event happens on one of our
247          * children.
248          */
249         spin_lock(&destroy_lock);
250         list_add(&mark->g_list, &destroy_list);
251         spin_unlock(&destroy_lock);
252         queue_delayed_work(system_unbound_wq, &reaper_work,
253                            FSNOTIFY_REAPER_DELAY);
254 }
255
256 bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
257 {
258         struct fsnotify_group *group;
259
260         if (WARN_ON_ONCE(!iter_info->inode_mark && !iter_info->vfsmount_mark))
261                 return false;
262
263         if (iter_info->inode_mark)
264                 group = iter_info->inode_mark->group;
265         else
266                 group = iter_info->vfsmount_mark->group;
267
268         /*
269          * Since acquisition of mark reference is an atomic op as well, we can
270          * be sure this inc is seen before any effect of refcount increment.
271          */
272         atomic_inc(&group->user_waits);
273
274         if (iter_info->inode_mark) {
275                 /* This can fail if mark is being removed */
276                 if (!fsnotify_get_mark_safe(iter_info->inode_mark))
277                         goto out_wait;
278         }
279         if (iter_info->vfsmount_mark) {
280                 if (!fsnotify_get_mark_safe(iter_info->vfsmount_mark))
281                         goto out_inode;
282         }
283
284         /*
285          * Now that both marks are pinned by refcount in the inode / vfsmount
286          * lists, we can drop SRCU lock, and safely resume the list iteration
287          * once userspace returns.
288          */
289         srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
290
291         return true;
292 out_inode:
293         if (iter_info->inode_mark)
294                 fsnotify_put_mark(iter_info->inode_mark);
295 out_wait:
296         if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
297                 wake_up(&group->notification_waitq);
298         return false;
299 }
300
301 void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
302 {
303         struct fsnotify_group *group = NULL;
304
305         iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
306         if (iter_info->inode_mark) {
307                 group = iter_info->inode_mark->group;
308                 fsnotify_put_mark(iter_info->inode_mark);
309         }
310         if (iter_info->vfsmount_mark) {
311                 group = iter_info->vfsmount_mark->group;
312                 fsnotify_put_mark(iter_info->vfsmount_mark);
313         }
314         /*
315          * We abuse notification_waitq on group shutdown for waiting for all
316          * marks pinned when waiting for userspace.
317          */
318         if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
319                 wake_up(&group->notification_waitq);
320 }
321
322 /*
323  * Mark mark as detached, remove it from group list. Mark still stays in object
324  * list until its last reference is dropped. Note that we rely on mark being
325  * removed from group list before corresponding reference to it is dropped. In
326  * particular we rely on mark->connector being valid while we hold
327  * group->mark_mutex if we found the mark through g_list.
328  *
329  * Must be called with group->mark_mutex held. The caller must either hold
330  * reference to the mark or be protected by fsnotify_mark_srcu.
331  */
332 void fsnotify_detach_mark(struct fsnotify_mark *mark)
333 {
334         struct fsnotify_group *group = mark->group;
335
336         WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
337         WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
338                      atomic_read(&mark->refcnt) < 1 +
339                         !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
340
341         spin_lock(&mark->lock);
342         /* something else already called this function on this mark */
343         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
344                 spin_unlock(&mark->lock);
345                 return;
346         }
347         mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
348         list_del_init(&mark->g_list);
349         spin_unlock(&mark->lock);
350
351         atomic_dec(&group->num_marks);
352
353         /* Drop mark reference acquired in fsnotify_add_mark_locked() */
354         fsnotify_put_mark(mark);
355 }
356
357 /*
358  * Free fsnotify mark. The mark is actually only marked as being freed.  The
359  * freeing is actually happening only once last reference to the mark is
360  * dropped from a workqueue which first waits for srcu period end.
361  *
362  * Caller must have a reference to the mark or be protected by
363  * fsnotify_mark_srcu.
364  */
365 void fsnotify_free_mark(struct fsnotify_mark *mark)
366 {
367         struct fsnotify_group *group = mark->group;
368
369         spin_lock(&mark->lock);
370         /* something else already called this function on this mark */
371         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
372                 spin_unlock(&mark->lock);
373                 return;
374         }
375         mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
376         spin_unlock(&mark->lock);
377
378         /*
379          * Some groups like to know that marks are being freed.  This is a
380          * callback to the group function to let it know that this mark
381          * is being freed.
382          */
383         if (group->ops->freeing_mark)
384                 group->ops->freeing_mark(mark, group);
385 }
386
387 void fsnotify_destroy_mark(struct fsnotify_mark *mark,
388                            struct fsnotify_group *group)
389 {
390         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
391         fsnotify_detach_mark(mark);
392         mutex_unlock(&group->mark_mutex);
393         fsnotify_free_mark(mark);
394 }
395
396 void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask)
397 {
398         assert_spin_locked(&mark->lock);
399
400         mark->mask = mask;
401 }
402
403 void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask)
404 {
405         assert_spin_locked(&mark->lock);
406
407         mark->ignored_mask = mask;
408 }
409
410 /*
411  * Sorting function for lists of fsnotify marks.
412  *
413  * Fanotify supports different notification classes (reflected as priority of
414  * notification group). Events shall be passed to notification groups in
415  * decreasing priority order. To achieve this marks in notification lists for
416  * inodes and vfsmounts are sorted so that priorities of corresponding groups
417  * are descending.
418  *
419  * Furthermore correct handling of the ignore mask requires processing inode
420  * and vfsmount marks of each group together. Using the group address as
421  * further sort criterion provides a unique sorting order and thus we can
422  * merge inode and vfsmount lists of marks in linear time and find groups
423  * present in both lists.
424  *
425  * A return value of 1 signifies that b has priority over a.
426  * A return value of 0 signifies that the two marks have to be handled together.
427  * A return value of -1 signifies that a has priority over b.
428  */
429 int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
430 {
431         if (a == b)
432                 return 0;
433         if (!a)
434                 return 1;
435         if (!b)
436                 return -1;
437         if (a->priority < b->priority)
438                 return 1;
439         if (a->priority > b->priority)
440                 return -1;
441         if (a < b)
442                 return 1;
443         return -1;
444 }
445
446 static int fsnotify_attach_connector_to_object(
447                                 struct fsnotify_mark_connector __rcu **connp,
448                                 struct inode *inode,
449                                 struct vfsmount *mnt)
450 {
451         struct fsnotify_mark_connector *conn;
452
453         conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
454         if (!conn)
455                 return -ENOMEM;
456         spin_lock_init(&conn->lock);
457         INIT_HLIST_HEAD(&conn->list);
458         if (inode) {
459                 conn->flags = FSNOTIFY_OBJ_TYPE_INODE;
460                 conn->inode = igrab(inode);
461         } else {
462                 conn->flags = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
463                 conn->mnt = mnt;
464         }
465         /*
466          * cmpxchg() provides the barrier so that readers of *connp can see
467          * only initialized structure
468          */
469         if (cmpxchg(connp, NULL, conn)) {
470                 /* Someone else created list structure for us */
471                 if (inode)
472                         iput(inode);
473                 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
474         }
475
476         return 0;
477 }
478
479 /*
480  * Get mark connector, make sure it is alive and return with its lock held.
481  * This is for users that get connector pointer from inode or mount. Users that
482  * hold reference to a mark on the list may directly lock connector->lock as
483  * they are sure list cannot go away under them.
484  */
485 static struct fsnotify_mark_connector *fsnotify_grab_connector(
486                                 struct fsnotify_mark_connector __rcu **connp)
487 {
488         struct fsnotify_mark_connector *conn;
489         int idx;
490
491         idx = srcu_read_lock(&fsnotify_mark_srcu);
492         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
493         if (!conn)
494                 goto out;
495         spin_lock(&conn->lock);
496         if (!(conn->flags & (FSNOTIFY_OBJ_TYPE_INODE |
497                              FSNOTIFY_OBJ_TYPE_VFSMOUNT))) {
498                 spin_unlock(&conn->lock);
499                 srcu_read_unlock(&fsnotify_mark_srcu, idx);
500                 return NULL;
501         }
502 out:
503         srcu_read_unlock(&fsnotify_mark_srcu, idx);
504         return conn;
505 }
506
507 /*
508  * Add mark into proper place in given list of marks. These marks may be used
509  * for the fsnotify backend to determine which event types should be delivered
510  * to which group and for which inodes. These marks are ordered according to
511  * priority, highest number first, and then by the group's location in memory.
512  */
513 static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
514                                   struct inode *inode, struct vfsmount *mnt,
515                                   int allow_dups)
516 {
517         struct fsnotify_mark *lmark, *last = NULL;
518         struct fsnotify_mark_connector *conn;
519         struct fsnotify_mark_connector __rcu **connp;
520         int cmp;
521         int err = 0;
522
523         if (WARN_ON(!inode && !mnt))
524                 return -EINVAL;
525         if (inode)
526                 connp = &inode->i_fsnotify_marks;
527         else
528                 connp = &real_mount(mnt)->mnt_fsnotify_marks;
529 restart:
530         spin_lock(&mark->lock);
531         conn = fsnotify_grab_connector(connp);
532         if (!conn) {
533                 spin_unlock(&mark->lock);
534                 err = fsnotify_attach_connector_to_object(connp, inode, mnt);
535                 if (err)
536                         return err;
537                 goto restart;
538         }
539
540         /* is mark the first mark? */
541         if (hlist_empty(&conn->list)) {
542                 hlist_add_head_rcu(&mark->obj_list, &conn->list);
543                 goto added;
544         }
545
546         /* should mark be in the middle of the current list? */
547         hlist_for_each_entry(lmark, &conn->list, obj_list) {
548                 last = lmark;
549
550                 if ((lmark->group == mark->group) &&
551                     (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
552                     !allow_dups) {
553                         err = -EEXIST;
554                         goto out_err;
555                 }
556
557                 cmp = fsnotify_compare_groups(lmark->group, mark->group);
558                 if (cmp >= 0) {
559                         hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
560                         goto added;
561                 }
562         }
563
564         BUG_ON(last == NULL);
565         /* mark should be the last entry.  last is the current last entry */
566         hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
567 added:
568         mark->connector = conn;
569 out_err:
570         spin_unlock(&conn->lock);
571         spin_unlock(&mark->lock);
572         return err;
573 }
574
575 /*
576  * Attach an initialized mark to a given group and fs object.
577  * These marks may be used for the fsnotify backend to determine which
578  * event types should be delivered to which group.
579  */
580 int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
581                              struct fsnotify_group *group, struct inode *inode,
582                              struct vfsmount *mnt, int allow_dups)
583 {
584         int ret = 0;
585
586         BUG_ON(inode && mnt);
587         BUG_ON(!inode && !mnt);
588         BUG_ON(!mutex_is_locked(&group->mark_mutex));
589
590         /*
591          * LOCKING ORDER!!!!
592          * group->mark_mutex
593          * mark->lock
594          * mark->connector->lock
595          */
596         spin_lock(&mark->lock);
597         mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
598
599         fsnotify_get_group(group);
600         mark->group = group;
601         list_add(&mark->g_list, &group->marks_list);
602         atomic_inc(&group->num_marks);
603         fsnotify_get_mark(mark); /* for g_list */
604         spin_unlock(&mark->lock);
605
606         ret = fsnotify_add_mark_list(mark, inode, mnt, allow_dups);
607         if (ret)
608                 goto err;
609
610         if (mark->mask)
611                 fsnotify_recalc_mask(mark->connector);
612
613         return ret;
614 err:
615         mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
616                          FSNOTIFY_MARK_FLAG_ATTACHED);
617         list_del_init(&mark->g_list);
618         atomic_dec(&group->num_marks);
619         spin_unlock(&mark->lock);
620
621         fsnotify_put_mark(mark);
622         return ret;
623 }
624
625 int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
626                       struct inode *inode, struct vfsmount *mnt, int allow_dups)
627 {
628         int ret;
629         mutex_lock(&group->mark_mutex);
630         ret = fsnotify_add_mark_locked(mark, group, inode, mnt, allow_dups);
631         mutex_unlock(&group->mark_mutex);
632         return ret;
633 }
634
635 /*
636  * Given a list of marks, find the mark associated with given group. If found
637  * take a reference to that mark and return it, else return NULL.
638  */
639 struct fsnotify_mark *fsnotify_find_mark(
640                                 struct fsnotify_mark_connector __rcu **connp,
641                                 struct fsnotify_group *group)
642 {
643         struct fsnotify_mark_connector *conn;
644         struct fsnotify_mark *mark;
645
646         conn = fsnotify_grab_connector(connp);
647         if (!conn)
648                 return NULL;
649
650         hlist_for_each_entry(mark, &conn->list, obj_list) {
651                 if (mark->group == group &&
652                     (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
653                         fsnotify_get_mark(mark);
654                         spin_unlock(&conn->lock);
655                         return mark;
656                 }
657         }
658         spin_unlock(&conn->lock);
659         return NULL;
660 }
661
662 /*
663  * clear any marks in a group in which mark->flags & flags is true
664  */
665 void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group,
666                                          unsigned int flags)
667 {
668         struct fsnotify_mark *lmark, *mark;
669         LIST_HEAD(to_free);
670
671         /*
672          * We have to be really careful here. Anytime we drop mark_mutex, e.g.
673          * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
674          * to_free list so we have to use mark_mutex even when accessing that
675          * list. And freeing mark requires us to drop mark_mutex. So we can
676          * reliably free only the first mark in the list. That's why we first
677          * move marks to free to to_free list in one go and then free marks in
678          * to_free list one by one.
679          */
680         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
681         list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
682                 if (mark->connector->flags & flags)
683                         list_move(&mark->g_list, &to_free);
684         }
685         mutex_unlock(&group->mark_mutex);
686
687         while (1) {
688                 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
689                 if (list_empty(&to_free)) {
690                         mutex_unlock(&group->mark_mutex);
691                         break;
692                 }
693                 mark = list_first_entry(&to_free, struct fsnotify_mark, g_list);
694                 fsnotify_get_mark(mark);
695                 fsnotify_detach_mark(mark);
696                 mutex_unlock(&group->mark_mutex);
697                 fsnotify_free_mark(mark);
698                 fsnotify_put_mark(mark);
699         }
700 }
701
702 /*
703  * Given a group, prepare for freeing all the marks associated with that group.
704  * The marks are attached to the list of marks prepared for destruction, the
705  * caller is responsible for freeing marks in that list after SRCU period has
706  * ended.
707  */
708 void fsnotify_detach_group_marks(struct fsnotify_group *group)
709 {
710         struct fsnotify_mark *mark;
711
712         while (1) {
713                 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
714                 if (list_empty(&group->marks_list)) {
715                         mutex_unlock(&group->mark_mutex);
716                         break;
717                 }
718                 mark = list_first_entry(&group->marks_list,
719                                         struct fsnotify_mark, g_list);
720                 fsnotify_get_mark(mark);
721                 fsnotify_detach_mark(mark);
722                 mutex_unlock(&group->mark_mutex);
723                 fsnotify_free_mark(mark);
724                 fsnotify_put_mark(mark);
725         }
726         /*
727          * Some marks can still be pinned when waiting for response from
728          * userspace. Wait for those now. fsnotify_prepare_user_wait() will
729          * not succeed now so this wait is race-free.
730          */
731         wait_event(group->notification_waitq, !atomic_read(&group->user_waits));
732 }
733
734 /* Destroy all marks attached to inode / vfsmount */
735 void fsnotify_destroy_marks(struct fsnotify_mark_connector __rcu **connp)
736 {
737         struct fsnotify_mark_connector *conn;
738         struct fsnotify_mark *mark, *old_mark = NULL;
739         struct inode *inode;
740
741         conn = fsnotify_grab_connector(connp);
742         if (!conn)
743                 return;
744         /*
745          * We have to be careful since we can race with e.g.
746          * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
747          * list can get modified. However we are holding mark reference and
748          * thus our mark cannot be removed from obj_list so we can continue
749          * iteration after regaining conn->lock.
750          */
751         hlist_for_each_entry(mark, &conn->list, obj_list) {
752                 fsnotify_get_mark(mark);
753                 spin_unlock(&conn->lock);
754                 if (old_mark)
755                         fsnotify_put_mark(old_mark);
756                 old_mark = mark;
757                 fsnotify_destroy_mark(mark, mark->group);
758                 spin_lock(&conn->lock);
759         }
760         /*
761          * Detach list from object now so that we don't pin inode until all
762          * mark references get dropped. It would lead to strange results such
763          * as delaying inode deletion or blocking unmount.
764          */
765         inode = fsnotify_detach_connector_from_object(conn);
766         spin_unlock(&conn->lock);
767         if (old_mark)
768                 fsnotify_put_mark(old_mark);
769         iput(inode);
770 }
771
772 /*
773  * Nothing fancy, just initialize lists and locks and counters.
774  */
775 void fsnotify_init_mark(struct fsnotify_mark *mark,
776                         void (*free_mark)(struct fsnotify_mark *mark))
777 {
778         memset(mark, 0, sizeof(*mark));
779         spin_lock_init(&mark->lock);
780         atomic_set(&mark->refcnt, 1);
781         mark->free_mark = free_mark;
782 }
783
784 /*
785  * Destroy all marks in destroy_list, waits for SRCU period to finish before
786  * actually freeing marks.
787  */
788 static void fsnotify_mark_destroy_workfn(struct work_struct *work)
789 {
790         struct fsnotify_mark *mark, *next;
791         struct list_head private_destroy_list;
792
793         spin_lock(&destroy_lock);
794         /* exchange the list head */
795         list_replace_init(&destroy_list, &private_destroy_list);
796         spin_unlock(&destroy_lock);
797
798         synchronize_srcu(&fsnotify_mark_srcu);
799
800         list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
801                 list_del_init(&mark->g_list);
802                 fsnotify_final_mark_destroy(mark);
803         }
804 }
805
806 /* Wait for all marks queued for destruction to be actually destroyed */
807 void fsnotify_wait_marks_destroyed(void)
808 {
809         flush_delayed_work(&reaper_work);
810 }