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