]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/notify/mark.c
UBUNTU: SAUCE: Import aufs driver
[mirror_ubuntu-bionic-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{
ab97f873
ER
108 WARN_ON_ONCE(!refcount_read(&mark->refcnt));
109 refcount_inc(&mark->refcnt);
5444e298 110}
c088e31d 111EXPORT_SYMBOL_GPL(fsnotify_put_mark);
5444e298 112
a242677b 113static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
0809ab69
JK
114{
115 u32 new_mask = 0;
116 struct fsnotify_mark *mark;
117
04662cab 118 assert_spin_locked(&conn->lock);
6b3f05d2
JK
119 hlist_for_each_entry(mark, &conn->list, obj_list) {
120 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)
121 new_mask |= mark->mask;
122 }
a242677b
JK
123 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
124 conn->inode->i_fsnotify_mask = new_mask;
125 else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT)
126 real_mount(conn->mnt)->mnt_fsnotify_mask = new_mask;
127}
128
129/*
130 * Calculate mask of events for a list of marks. The caller must make sure
6b3f05d2
JK
131 * connector and connector->inode cannot disappear under us. Callers achieve
132 * this by holding a mark->lock or mark->group->mark_mutex for a mark on this
133 * list.
a242677b
JK
134 */
135void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
136{
137 if (!conn)
138 return;
139
04662cab 140 spin_lock(&conn->lock);
a242677b 141 __fsnotify_recalc_mask(conn);
04662cab
JK
142 spin_unlock(&conn->lock);
143 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
a242677b 144 __fsnotify_update_child_dentry_flags(conn->inode);
0809ab69
JK
145}
146
08991e83
JK
147/* Free all connectors queued for freeing once SRCU period ends */
148static void fsnotify_connector_destroy_workfn(struct work_struct *work)
149{
150 struct fsnotify_mark_connector *conn, *free;
151
152 spin_lock(&destroy_lock);
153 conn = connector_destroy_list;
154 connector_destroy_list = NULL;
155 spin_unlock(&destroy_lock);
156
157 synchronize_srcu(&fsnotify_mark_srcu);
158 while (conn) {
159 free = conn;
160 conn = conn->destroy_next;
161 kmem_cache_free(fsnotify_mark_connector_cachep, free);
162 }
163}
164
08991e83
JK
165static struct inode *fsnotify_detach_connector_from_object(
166 struct fsnotify_mark_connector *conn)
167{
168 struct inode *inode = NULL;
169
170 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE) {
171 inode = conn->inode;
172 rcu_assign_pointer(inode->i_fsnotify_marks, NULL);
173 inode->i_fsnotify_mask = 0;
174 conn->inode = NULL;
175 conn->flags &= ~FSNOTIFY_OBJ_TYPE_INODE;
176 } else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
177 rcu_assign_pointer(real_mount(conn->mnt)->mnt_fsnotify_marks,
178 NULL);
179 real_mount(conn->mnt)->mnt_fsnotify_mask = 0;
180 conn->mnt = NULL;
181 conn->flags &= ~FSNOTIFY_OBJ_TYPE_VFSMOUNT;
182 }
183
184 return inode;
185}
186
6b3f05d2
JK
187static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
188{
054c636e
JK
189 struct fsnotify_group *group = mark->group;
190
191 if (WARN_ON_ONCE(!group))
192 return;
193 group->ops->free_mark(mark);
194 fsnotify_put_group(group);
6b3f05d2
JK
195}
196
197void fsnotify_put_mark(struct fsnotify_mark *mark)
8212a609
JK
198{
199 struct fsnotify_mark_connector *conn;
200 struct inode *inode = NULL;
08991e83 201 bool free_conn = false;
8212a609 202
6b3f05d2
JK
203 /* Catch marks that were actually never attached to object */
204 if (!mark->connector) {
ab97f873 205 if (refcount_dec_and_test(&mark->refcnt))
6b3f05d2
JK
206 fsnotify_final_mark_destroy(mark);
207 return;
208 }
209
210 /*
211 * We have to be careful so that traversals of obj_list under lock can
212 * safely grab mark reference.
213 */
ab97f873 214 if (!refcount_dec_and_lock(&mark->refcnt, &mark->connector->lock))
6b3f05d2
JK
215 return;
216
8212a609 217 conn = mark->connector;
8212a609
JK
218 hlist_del_init_rcu(&mark->obj_list);
219 if (hlist_empty(&conn->list)) {
08991e83
JK
220 inode = fsnotify_detach_connector_from_object(conn);
221 free_conn = true;
222 } else {
223 __fsnotify_recalc_mask(conn);
8212a609
JK
224 }
225 mark->connector = NULL;
04662cab 226 spin_unlock(&conn->lock);
8212a609 227
6b3f05d2
JK
228 iput(inode);
229
08991e83
JK
230 if (free_conn) {
231 spin_lock(&destroy_lock);
232 conn->destroy_next = connector_destroy_list;
233 connector_destroy_list = conn;
234 spin_unlock(&destroy_lock);
235 queue_work(system_unbound_wq, &connector_reaper_work);
236 }
6b3f05d2
JK
237 /*
238 * Note that we didn't update flags telling whether inode cares about
239 * what's happening with children. We update these flags from
240 * __fsnotify_parent() lazily when next event happens on one of our
241 * children.
242 */
243 spin_lock(&destroy_lock);
244 list_add(&mark->g_list, &destroy_list);
245 spin_unlock(&destroy_lock);
246 queue_delayed_work(system_unbound_wq, &reaper_work,
247 FSNOTIFY_REAPER_DELAY);
8212a609
JK
248}
249
24c20305
MS
250/*
251 * Get mark reference when we found the mark via lockless traversal of object
252 * list. Mark can be already removed from the list by now and on its way to be
253 * destroyed once SRCU period ends.
254 *
255 * Also pin the group so it doesn't disappear under us.
256 */
257static bool fsnotify_get_mark_safe(struct fsnotify_mark *mark)
abc77577 258{
24c20305
MS
259 if (!mark)
260 return true;
abc77577 261
ab97f873 262 if (refcount_inc_not_zero(&mark->refcnt)) {
9a31d7ad
MS
263 spin_lock(&mark->lock);
264 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) {
265 /* mark is attached, group is still alive then */
266 atomic_inc(&mark->group->user_waits);
267 spin_unlock(&mark->lock);
268 return true;
269 }
270 spin_unlock(&mark->lock);
271 fsnotify_put_mark(mark);
272 }
24c20305
MS
273 return false;
274}
275
276/*
277 * Puts marks and wakes up group destruction if necessary.
278 *
279 * Pairs with fsnotify_get_mark_safe()
280 */
281static void fsnotify_put_mark_wake(struct fsnotify_mark *mark)
282{
283 if (mark) {
284 struct fsnotify_group *group = mark->group;
285
286 fsnotify_put_mark(mark);
287 /*
288 * We abuse notification_waitq on group shutdown for waiting for
289 * all marks pinned when waiting for userspace.
290 */
291 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
292 wake_up(&group->notification_waitq);
abc77577 293 }
24c20305
MS
294}
295
296bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
297{
298 /* This can fail if mark is being removed */
299 if (!fsnotify_get_mark_safe(iter_info->inode_mark))
300 return false;
301 if (!fsnotify_get_mark_safe(iter_info->vfsmount_mark)) {
302 fsnotify_put_mark_wake(iter_info->inode_mark);
303 return false;
abc77577
JK
304 }
305
306 /*
307 * Now that both marks are pinned by refcount in the inode / vfsmount
308 * lists, we can drop SRCU lock, and safely resume the list iteration
309 * once userspace returns.
310 */
311 srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
312
313 return true;
abc77577
JK
314}
315
316void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
317{
abc77577 318 iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
24c20305
MS
319 fsnotify_put_mark_wake(iter_info->inode_mark);
320 fsnotify_put_mark_wake(iter_info->vfsmount_mark);
abc77577
JK
321}
322
5444e298 323/*
6b3f05d2
JK
324 * Mark mark as detached, remove it from group list. Mark still stays in object
325 * list until its last reference is dropped. Note that we rely on mark being
326 * removed from group list before corresponding reference to it is dropped. In
327 * particular we rely on mark->connector being valid while we hold
328 * group->mark_mutex if we found the mark through g_list.
4712e722 329 *
11375145
JK
330 * Must be called with group->mark_mutex held. The caller must either hold
331 * reference to the mark or be protected by fsnotify_mark_srcu.
5444e298 332 */
4712e722 333void fsnotify_detach_mark(struct fsnotify_mark *mark)
5444e298 334{
4712e722 335 struct fsnotify_group *group = mark->group;
5444e298 336
11375145
JK
337 WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
338 WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
ab97f873 339 refcount_read(&mark->refcnt) < 1 +
11375145 340 !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
d5a335b8 341
104d06f0 342 spin_lock(&mark->lock);
700307a2 343 /* something else already called this function on this mark */
4712e722 344 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
5444e298 345 spin_unlock(&mark->lock);
e2a29943 346 return;
5444e298 347 }
4712e722 348 mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
5444e298 349 list_del_init(&mark->g_list);
5444e298 350 spin_unlock(&mark->lock);
d5a335b8 351
4712e722 352 atomic_dec(&group->num_marks);
11375145
JK
353
354 /* Drop mark reference acquired in fsnotify_add_mark_locked() */
355 fsnotify_put_mark(mark);
4712e722
JK
356}
357
358/*
11375145
JK
359 * Free fsnotify mark. The mark is actually only marked as being freed. The
360 * freeing is actually happening only once last reference to the mark is
361 * dropped from a workqueue which first waits for srcu period end.
35e48176 362 *
11375145
JK
363 * Caller must have a reference to the mark or be protected by
364 * fsnotify_mark_srcu.
4712e722 365 */
11375145 366void fsnotify_free_mark(struct fsnotify_mark *mark)
4712e722
JK
367{
368 struct fsnotify_group *group = mark->group;
369
370 spin_lock(&mark->lock);
371 /* something else already called this function on this mark */
372 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
373 spin_unlock(&mark->lock);
11375145 374 return;
4712e722
JK
375 }
376 mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
377 spin_unlock(&mark->lock);
5444e298 378
d725e66c
LT
379 /*
380 * Some groups like to know that marks are being freed. This is a
381 * callback to the group function to let it know that this mark
382 * is being freed.
383 */
384 if (group->ops->freeing_mark)
385 group->ops->freeing_mark(mark, group);
d5a335b8
LS
386}
387
388void fsnotify_destroy_mark(struct fsnotify_mark *mark,
389 struct fsnotify_group *group)
390{
6960b0d9 391 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
4712e722 392 fsnotify_detach_mark(mark);
d5a335b8 393 mutex_unlock(&group->mark_mutex);
4712e722 394 fsnotify_free_mark(mark);
5444e298 395}
c088e31d 396EXPORT_SYMBOL_GPL(fsnotify_destroy_mark);
5444e298 397
8edc6e16
JK
398/*
399 * Sorting function for lists of fsnotify marks.
400 *
401 * Fanotify supports different notification classes (reflected as priority of
402 * notification group). Events shall be passed to notification groups in
403 * decreasing priority order. To achieve this marks in notification lists for
404 * inodes and vfsmounts are sorted so that priorities of corresponding groups
405 * are descending.
406 *
407 * Furthermore correct handling of the ignore mask requires processing inode
408 * and vfsmount marks of each group together. Using the group address as
409 * further sort criterion provides a unique sorting order and thus we can
410 * merge inode and vfsmount lists of marks in linear time and find groups
411 * present in both lists.
412 *
413 * A return value of 1 signifies that b has priority over a.
414 * A return value of 0 signifies that the two marks have to be handled together.
415 * A return value of -1 signifies that a has priority over b.
416 */
417int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
418{
419 if (a == b)
420 return 0;
421 if (!a)
422 return 1;
423 if (!b)
424 return -1;
425 if (a->priority < b->priority)
426 return 1;
427 if (a->priority > b->priority)
428 return -1;
429 if (a < b)
430 return 1;
431 return -1;
432}
433
9dd813c1 434static int fsnotify_attach_connector_to_object(
08991e83
JK
435 struct fsnotify_mark_connector __rcu **connp,
436 struct inode *inode,
437 struct vfsmount *mnt)
9dd813c1
JK
438{
439 struct fsnotify_mark_connector *conn;
440
755b5bc6 441 conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
9dd813c1
JK
442 if (!conn)
443 return -ENOMEM;
04662cab 444 spin_lock_init(&conn->lock);
9dd813c1 445 INIT_HLIST_HEAD(&conn->list);
86ffe245
JK
446 if (inode) {
447 conn->flags = FSNOTIFY_OBJ_TYPE_INODE;
08991e83 448 conn->inode = igrab(inode);
86ffe245
JK
449 } else {
450 conn->flags = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
451 conn->mnt = mnt;
452 }
9dd813c1 453 /*
04662cab
JK
454 * cmpxchg() provides the barrier so that readers of *connp can see
455 * only initialized structure
9dd813c1 456 */
04662cab
JK
457 if (cmpxchg(connp, NULL, conn)) {
458 /* Someone else created list structure for us */
08991e83
JK
459 if (inode)
460 iput(inode);
755b5bc6 461 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
04662cab 462 }
9dd813c1
JK
463
464 return 0;
465}
466
08991e83
JK
467/*
468 * Get mark connector, make sure it is alive and return with its lock held.
469 * This is for users that get connector pointer from inode or mount. Users that
470 * hold reference to a mark on the list may directly lock connector->lock as
471 * they are sure list cannot go away under them.
472 */
473static struct fsnotify_mark_connector *fsnotify_grab_connector(
474 struct fsnotify_mark_connector __rcu **connp)
475{
476 struct fsnotify_mark_connector *conn;
477 int idx;
478
479 idx = srcu_read_lock(&fsnotify_mark_srcu);
480 conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
481 if (!conn)
482 goto out;
483 spin_lock(&conn->lock);
484 if (!(conn->flags & (FSNOTIFY_OBJ_TYPE_INODE |
485 FSNOTIFY_OBJ_TYPE_VFSMOUNT))) {
486 spin_unlock(&conn->lock);
487 srcu_read_unlock(&fsnotify_mark_srcu, idx);
488 return NULL;
489 }
490out:
491 srcu_read_unlock(&fsnotify_mark_srcu, idx);
492 return conn;
493}
494
9dd813c1
JK
495/*
496 * Add mark into proper place in given list of marks. These marks may be used
497 * for the fsnotify backend to determine which event types should be delivered
498 * to which group and for which inodes. These marks are ordered according to
499 * priority, highest number first, and then by the group's location in memory.
500 */
755b5bc6
JK
501static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
502 struct inode *inode, struct vfsmount *mnt,
503 int allow_dups)
0809ab69
JK
504{
505 struct fsnotify_mark *lmark, *last = NULL;
9dd813c1 506 struct fsnotify_mark_connector *conn;
08991e83 507 struct fsnotify_mark_connector __rcu **connp;
0809ab69 508 int cmp;
755b5bc6
JK
509 int err = 0;
510
511 if (WARN_ON(!inode && !mnt))
512 return -EINVAL;
04662cab 513 if (inode)
755b5bc6 514 connp = &inode->i_fsnotify_marks;
04662cab 515 else
755b5bc6 516 connp = &real_mount(mnt)->mnt_fsnotify_marks;
08991e83
JK
517restart:
518 spin_lock(&mark->lock);
519 conn = fsnotify_grab_connector(connp);
520 if (!conn) {
521 spin_unlock(&mark->lock);
04662cab 522 err = fsnotify_attach_connector_to_object(connp, inode, mnt);
9dd813c1
JK
523 if (err)
524 return err;
08991e83 525 goto restart;
9dd813c1 526 }
0809ab69
JK
527
528 /* is mark the first mark? */
9dd813c1
JK
529 if (hlist_empty(&conn->list)) {
530 hlist_add_head_rcu(&mark->obj_list, &conn->list);
86ffe245 531 goto added;
0809ab69
JK
532 }
533
534 /* should mark be in the middle of the current list? */
9dd813c1 535 hlist_for_each_entry(lmark, &conn->list, obj_list) {
0809ab69
JK
536 last = lmark;
537
6b3f05d2
JK
538 if ((lmark->group == mark->group) &&
539 (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
540 !allow_dups) {
755b5bc6
JK
541 err = -EEXIST;
542 goto out_err;
543 }
0809ab69
JK
544
545 cmp = fsnotify_compare_groups(lmark->group, mark->group);
546 if (cmp >= 0) {
547 hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
86ffe245 548 goto added;
0809ab69
JK
549 }
550 }
551
552 BUG_ON(last == NULL);
553 /* mark should be the last entry. last is the current last entry */
554 hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
86ffe245
JK
555added:
556 mark->connector = conn;
755b5bc6 557out_err:
04662cab 558 spin_unlock(&conn->lock);
755b5bc6
JK
559 spin_unlock(&mark->lock);
560 return err;
0809ab69
JK
561}
562
5444e298
EP
563/*
564 * Attach an initialized mark to a given group and fs object.
565 * These marks may be used for the fsnotify backend to determine which
566 * event types should be delivered to which group.
567 */
7b129323 568int fsnotify_add_mark_locked(struct fsnotify_mark *mark, struct inode *inode,
d5a335b8 569 struct vfsmount *mnt, int allow_dups)
5444e298 570{
7b129323 571 struct fsnotify_group *group = mark->group;
5444e298
EP
572 int ret = 0;
573
5444e298
EP
574 BUG_ON(inode && mnt);
575 BUG_ON(!inode && !mnt);
d5a335b8 576 BUG_ON(!mutex_is_locked(&group->mark_mutex));
5444e298 577
5444e298
EP
578 /*
579 * LOCKING ORDER!!!!
986ab098 580 * group->mark_mutex
104d06f0 581 * mark->lock
04662cab 582 * mark->connector->lock
5444e298 583 */
104d06f0 584 spin_lock(&mark->lock);
4712e722 585 mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
700307a2 586
5444e298
EP
587 list_add(&mark->g_list, &group->marks_list);
588 atomic_inc(&group->num_marks);
6b3f05d2 589 fsnotify_get_mark(mark); /* for g_list */
5444e298
EP
590 spin_unlock(&mark->lock);
591
755b5bc6
JK
592 ret = fsnotify_add_mark_list(mark, inode, mnt, allow_dups);
593 if (ret)
594 goto err;
595
a242677b
JK
596 if (mark->mask)
597 fsnotify_recalc_mask(mark->connector);
5444e298
EP
598
599 return ret;
600err:
9cf90cef 601 spin_lock(&mark->lock);
11375145
JK
602 mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
603 FSNOTIFY_MARK_FLAG_ATTACHED);
5444e298 604 list_del_init(&mark->g_list);
9cf90cef 605 spin_unlock(&mark->lock);
5444e298 606 atomic_dec(&group->num_marks);
5444e298 607
11375145 608 fsnotify_put_mark(mark);
5444e298
EP
609 return ret;
610}
c088e31d 611EXPORT_SYMBOL_GPL(fsnotify_add_mark);
5444e298 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 742 spin_lock_init(&mark->lock);
ab97f873 743 refcount_set(&mark->refcnt, 1);
7b129323
JK
744 fsnotify_get_group(group);
745 mark->group = group;
5444e298 746}
c088e31d 747EXPORT_SYMBOL_GPL(fsnotify_init_mark);
13d34ac6 748
35e48176
JK
749/*
750 * Destroy all marks in destroy_list, waits for SRCU period to finish before
751 * actually freeing marks.
752 */
f09b04a0 753static void fsnotify_mark_destroy_workfn(struct work_struct *work)
13d34ac6
JL
754{
755 struct fsnotify_mark *mark, *next;
756 struct list_head private_destroy_list;
757
0918f1c3
JL
758 spin_lock(&destroy_lock);
759 /* exchange the list head */
760 list_replace_init(&destroy_list, &private_destroy_list);
761 spin_unlock(&destroy_lock);
13d34ac6 762
0918f1c3 763 synchronize_srcu(&fsnotify_mark_srcu);
13d34ac6 764
0918f1c3
JL
765 list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
766 list_del_init(&mark->g_list);
6b3f05d2 767 fsnotify_final_mark_destroy(mark);
13d34ac6 768 }
13d34ac6 769}
35e48176 770
f09b04a0
JK
771/* Wait for all marks queued for destruction to be actually destroyed */
772void fsnotify_wait_marks_destroyed(void)
35e48176 773{
f09b04a0 774 flush_delayed_work(&reaper_work);
35e48176 775}