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