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