blob: 55955ded338d6d78fdc7f348da680e4a0e6ce38c [file] [log] [blame]
Eric Paris5444e292009-12-17 21:24:27 -05001/*
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:
Lino Sanfilippo9756b912013-07-08 15:59:46 -070023 * 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.
Eric Paris5444e292009-12-17 21:24:27 -050029 *
30 * LOCKING:
Lino Sanfilippo9756b912013-07-08 15:59:46 -070031 * There are 3 locks involved with fsnotify inode marks and they MUST be taken
32 * in order as follows:
Eric Paris5444e292009-12-17 21:24:27 -050033 *
Lino Sanfilippo9756b912013-07-08 15:59:46 -070034 * group->mark_mutex
Eric Paris5444e292009-12-17 21:24:27 -050035 * mark->lock
Jan Kara04662ca2017-02-01 08:19:43 +010036 * mark->connector->lock
Eric Paris5444e292009-12-17 21:24:27 -050037 *
Lino Sanfilippo9756b912013-07-08 15:59:46 -070038 * 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.
Eric Paris5444e292009-12-17 21:24:27 -050046 *
Jan Kara04662ca2017-02-01 08:19:43 +010047 * mark->connector->lock protects the list of marks anchored inside an
48 * inode / vfsmount and each mark is hooked via the i_list.
Eric Paris5444e292009-12-17 21:24:27 -050049 *
Jan Kara04662ca2017-02-01 08:19:43 +010050 * 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
Jan Kara6b3f05d2016-12-21 12:15:30 +010052 * 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.
Eric Paris5444e292009-12-17 21:24:27 -050059 *
60 * LIFETIME:
61 * Inode marks survive between when they are added to an inode and when their
Jan Karac1f33072016-12-16 10:53:32 +010062 * refcnt==0. Marks are also protected by fsnotify_mark_srcu.
Eric Paris5444e292009-12-17 21:24:27 -050063 *
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
Jan Kara2e37c6c2017-01-04 10:51:58 +010070 * need to be cleaned up. (fsnotify_clear_marks_by_group)
Eric Paris5444e292009-12-17 21:24:27 -050071 *
Eric Paris5444e292009-12-17 21:24:27 -050072 * 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>
Eric Paris75c1be42010-07-28 10:18:38 -040079#include <linux/kthread.h>
Eric Paris5444e292009-12-17 21:24:27 -050080#include <linux/module.h>
81#include <linux/mutex.h>
82#include <linux/slab.h>
83#include <linux/spinlock.h>
Eric Paris75c1be42010-07-28 10:18:38 -040084#include <linux/srcu.h>
Eric Paris5444e292009-12-17 21:24:27 -050085
Arun Sharma600634972011-07-26 16:09:06 -070086#include <linux/atomic.h>
Eric Paris5444e292009-12-17 21:24:27 -050087
88#include <linux/fsnotify_backend.h>
89#include "fsnotify.h"
90
Jeff Layton0918f1c2016-02-17 13:11:21 -080091#define FSNOTIFY_REAPER_DELAY (1) /* 1 jiffy */
92
Eric Paris75c1be42010-07-28 10:18:38 -040093struct srcu_struct fsnotify_mark_srcu;
Jan Kara9dd813c2017-03-14 12:31:02 +010094struct kmem_cache *fsnotify_mark_connector_cachep;
95
Jeff Layton13d34ac2016-02-17 13:11:18 -080096static DEFINE_SPINLOCK(destroy_lock);
97static LIST_HEAD(destroy_list);
Jan Kara08991e82017-02-01 09:21:58 +010098static struct fsnotify_mark_connector *connector_destroy_list;
Jeff Layton0918f1c2016-02-17 13:11:21 -080099
Jan Kara35e48172016-05-19 17:08:59 -0700100static void fsnotify_mark_destroy_workfn(struct work_struct *work);
101static DECLARE_DELAYED_WORK(reaper_work, fsnotify_mark_destroy_workfn);
Eric Paris75c1be42010-07-28 10:18:38 -0400102
Jan Kara08991e82017-02-01 09:21:58 +0100103static void fsnotify_connector_destroy_workfn(struct work_struct *work);
104static DECLARE_WORK(connector_reaper_work, fsnotify_connector_destroy_workfn);
105
Eric Paris5444e292009-12-17 21:24:27 -0500106void fsnotify_get_mark(struct fsnotify_mark *mark)
107{
Jan Kara11375142016-11-09 14:54:20 +0100108 WARN_ON_ONCE(!atomic_read(&mark->refcnt));
Eric Paris5444e292009-12-17 21:24:27 -0500109 atomic_inc(&mark->refcnt);
110}
111
Jan Karaabc77572016-11-10 16:02:11 +0100112/*
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}
121
Jan Karaa2426772017-03-15 09:16:27 +0100122static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
Jan Kara0809ab62014-12-12 16:58:36 -0800123{
124 u32 new_mask = 0;
125 struct fsnotify_mark *mark;
126
Jan Kara04662ca2017-02-01 08:19:43 +0100127 assert_spin_locked(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100128 hlist_for_each_entry(mark, &conn->list, obj_list) {
129 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)
130 new_mask |= mark->mask;
131 }
Jan Karaa2426772017-03-15 09:16:27 +0100132 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
133 conn->inode->i_fsnotify_mask = new_mask;
134 else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT)
135 real_mount(conn->mnt)->mnt_fsnotify_mask = new_mask;
136}
137
138/*
139 * Calculate mask of events for a list of marks. The caller must make sure
Jan Kara6b3f05d2016-12-21 12:15:30 +0100140 * connector and connector->inode cannot disappear under us. Callers achieve
141 * this by holding a mark->lock or mark->group->mark_mutex for a mark on this
142 * list.
Jan Karaa2426772017-03-15 09:16:27 +0100143 */
144void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
145{
146 if (!conn)
147 return;
148
Jan Kara04662ca2017-02-01 08:19:43 +0100149 spin_lock(&conn->lock);
Jan Karaa2426772017-03-15 09:16:27 +0100150 __fsnotify_recalc_mask(conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100151 spin_unlock(&conn->lock);
152 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
Jan Karaa2426772017-03-15 09:16:27 +0100153 __fsnotify_update_child_dentry_flags(conn->inode);
Jan Kara0809ab62014-12-12 16:58:36 -0800154}
155
Jan Kara08991e82017-02-01 09:21:58 +0100156/* Free all connectors queued for freeing once SRCU period ends */
157static void fsnotify_connector_destroy_workfn(struct work_struct *work)
158{
159 struct fsnotify_mark_connector *conn, *free;
160
161 spin_lock(&destroy_lock);
162 conn = connector_destroy_list;
163 connector_destroy_list = NULL;
164 spin_unlock(&destroy_lock);
165
166 synchronize_srcu(&fsnotify_mark_srcu);
167 while (conn) {
168 free = conn;
169 conn = conn->destroy_next;
170 kmem_cache_free(fsnotify_mark_connector_cachep, free);
171 }
172}
173
Jan Kara08991e82017-02-01 09:21:58 +0100174static struct inode *fsnotify_detach_connector_from_object(
175 struct fsnotify_mark_connector *conn)
176{
177 struct inode *inode = NULL;
178
179 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE) {
180 inode = conn->inode;
181 rcu_assign_pointer(inode->i_fsnotify_marks, NULL);
182 inode->i_fsnotify_mask = 0;
183 conn->inode = NULL;
184 conn->flags &= ~FSNOTIFY_OBJ_TYPE_INODE;
185 } else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
186 rcu_assign_pointer(real_mount(conn->mnt)->mnt_fsnotify_marks,
187 NULL);
188 real_mount(conn->mnt)->mnt_fsnotify_mask = 0;
189 conn->mnt = NULL;
190 conn->flags &= ~FSNOTIFY_OBJ_TYPE_VFSMOUNT;
191 }
192
193 return inode;
194}
195
Jan Kara6b3f05d2016-12-21 12:15:30 +0100196static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
197{
Jan Kara054c6362016-12-21 18:06:12 +0100198 struct fsnotify_group *group = mark->group;
199
200 if (WARN_ON_ONCE(!group))
201 return;
202 group->ops->free_mark(mark);
203 fsnotify_put_group(group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100204}
205
206void fsnotify_put_mark(struct fsnotify_mark *mark)
Jan Kara8212a602017-03-15 09:48:11 +0100207{
208 struct fsnotify_mark_connector *conn;
209 struct inode *inode = NULL;
Jan Kara08991e82017-02-01 09:21:58 +0100210 bool free_conn = false;
Jan Kara8212a602017-03-15 09:48:11 +0100211
Jan Kara6b3f05d2016-12-21 12:15:30 +0100212 /* Catch marks that were actually never attached to object */
213 if (!mark->connector) {
214 if (atomic_dec_and_test(&mark->refcnt))
215 fsnotify_final_mark_destroy(mark);
216 return;
217 }
218
219 /*
220 * We have to be careful so that traversals of obj_list under lock can
221 * safely grab mark reference.
222 */
223 if (!atomic_dec_and_lock(&mark->refcnt, &mark->connector->lock))
224 return;
225
Jan Kara8212a602017-03-15 09:48:11 +0100226 conn = mark->connector;
Jan Kara8212a602017-03-15 09:48:11 +0100227 hlist_del_init_rcu(&mark->obj_list);
228 if (hlist_empty(&conn->list)) {
Jan Kara08991e82017-02-01 09:21:58 +0100229 inode = fsnotify_detach_connector_from_object(conn);
230 free_conn = true;
231 } else {
232 __fsnotify_recalc_mask(conn);
Jan Kara8212a602017-03-15 09:48:11 +0100233 }
234 mark->connector = NULL;
Jan Kara04662ca2017-02-01 08:19:43 +0100235 spin_unlock(&conn->lock);
Jan Kara8212a602017-03-15 09:48:11 +0100236
Jan Kara6b3f05d2016-12-21 12:15:30 +0100237 iput(inode);
238
Jan Kara08991e82017-02-01 09:21:58 +0100239 if (free_conn) {
240 spin_lock(&destroy_lock);
241 conn->destroy_next = connector_destroy_list;
242 connector_destroy_list = conn;
243 spin_unlock(&destroy_lock);
244 queue_work(system_unbound_wq, &connector_reaper_work);
245 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100246 /*
247 * Note that we didn't update flags telling whether inode cares about
248 * what's happening with children. We update these flags from
249 * __fsnotify_parent() lazily when next event happens on one of our
250 * children.
251 */
252 spin_lock(&destroy_lock);
253 list_add(&mark->g_list, &destroy_list);
254 spin_unlock(&destroy_lock);
255 queue_delayed_work(system_unbound_wq, &reaper_work,
256 FSNOTIFY_REAPER_DELAY);
Jan Kara8212a602017-03-15 09:48:11 +0100257}
258
Jan Karaabc77572016-11-10 16:02:11 +0100259bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
260{
261 struct fsnotify_group *group;
262
263 if (WARN_ON_ONCE(!iter_info->inode_mark && !iter_info->vfsmount_mark))
264 return false;
265
266 if (iter_info->inode_mark)
267 group = iter_info->inode_mark->group;
268 else
269 group = iter_info->vfsmount_mark->group;
270
271 /*
272 * Since acquisition of mark reference is an atomic op as well, we can
273 * be sure this inc is seen before any effect of refcount increment.
274 */
275 atomic_inc(&group->user_waits);
276
277 if (iter_info->inode_mark) {
278 /* This can fail if mark is being removed */
279 if (!fsnotify_get_mark_safe(iter_info->inode_mark))
280 goto out_wait;
281 }
282 if (iter_info->vfsmount_mark) {
283 if (!fsnotify_get_mark_safe(iter_info->vfsmount_mark))
284 goto out_inode;
285 }
286
287 /*
288 * Now that both marks are pinned by refcount in the inode / vfsmount
289 * lists, we can drop SRCU lock, and safely resume the list iteration
290 * once userspace returns.
291 */
292 srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
293
294 return true;
295out_inode:
296 if (iter_info->inode_mark)
297 fsnotify_put_mark(iter_info->inode_mark);
298out_wait:
299 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
300 wake_up(&group->notification_waitq);
301 return false;
302}
303
304void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
305{
306 struct fsnotify_group *group = NULL;
307
308 iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
309 if (iter_info->inode_mark) {
310 group = iter_info->inode_mark->group;
311 fsnotify_put_mark(iter_info->inode_mark);
312 }
313 if (iter_info->vfsmount_mark) {
314 group = iter_info->vfsmount_mark->group;
315 fsnotify_put_mark(iter_info->vfsmount_mark);
316 }
317 /*
318 * We abuse notification_waitq on group shutdown for waiting for all
319 * marks pinned when waiting for userspace.
320 */
321 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
322 wake_up(&group->notification_waitq);
323}
324
Eric Paris5444e292009-12-17 21:24:27 -0500325/*
Jan Kara6b3f05d2016-12-21 12:15:30 +0100326 * 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.
Jan Kara4712e7222015-09-04 15:43:12 -0700331 *
Jan Kara11375142016-11-09 14:54:20 +0100332 * 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.
Eric Paris5444e292009-12-17 21:24:27 -0500334 */
Jan Kara4712e7222015-09-04 15:43:12 -0700335void fsnotify_detach_mark(struct fsnotify_mark *mark)
Eric Paris5444e292009-12-17 21:24:27 -0500336{
Jan Kara4712e7222015-09-04 15:43:12 -0700337 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500338
Jan Kara11375142016-11-09 14:54:20 +0100339 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));
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200343
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200344 spin_lock(&mark->lock);
Eric Paris700307a2010-07-28 10:18:38 -0400345 /* something else already called this function on this mark */
Jan Kara4712e7222015-09-04 15:43:12 -0700346 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Eric Paris5444e292009-12-17 21:24:27 -0500347 spin_unlock(&mark->lock);
Lino Sanfilippoe2a29942011-06-14 17:29:51 +0200348 return;
Eric Paris5444e292009-12-17 21:24:27 -0500349 }
Jan Kara4712e7222015-09-04 15:43:12 -0700350 mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris5444e292009-12-17 21:24:27 -0500351 list_del_init(&mark->g_list);
Eric Paris5444e292009-12-17 21:24:27 -0500352 spin_unlock(&mark->lock);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200353
Jan Kara4712e7222015-09-04 15:43:12 -0700354 atomic_dec(&group->num_marks);
Jan Kara11375142016-11-09 14:54:20 +0100355
356 /* Drop mark reference acquired in fsnotify_add_mark_locked() */
357 fsnotify_put_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700358}
359
360/*
Jan Kara11375142016-11-09 14:54:20 +0100361 * 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.
Jan Kara35e48172016-05-19 17:08:59 -0700364 *
Jan Kara11375142016-11-09 14:54:20 +0100365 * Caller must have a reference to the mark or be protected by
366 * fsnotify_mark_srcu.
Jan Kara4712e7222015-09-04 15:43:12 -0700367 */
Jan Kara11375142016-11-09 14:54:20 +0100368void fsnotify_free_mark(struct fsnotify_mark *mark)
Jan Kara4712e7222015-09-04 15:43:12 -0700369{
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);
Jan Kara11375142016-11-09 14:54:20 +0100376 return;
Jan Kara4712e7222015-09-04 15:43:12 -0700377 }
378 mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
379 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500380
Linus Torvaldsd725e662015-07-21 16:06:53 -0700381 /*
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);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200388}
389
390void fsnotify_destroy_mark(struct fsnotify_mark *mark,
391 struct fsnotify_group *group)
392{
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200393 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara4712e7222015-09-04 15:43:12 -0700394 fsnotify_detach_mark(mark);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200395 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700396 fsnotify_free_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500397}
398
399/*
Jan Kara8edc6e12014-11-13 15:19:33 -0800400 * 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
Jan Kara9dd813c2017-03-14 12:31:02 +0100435static int fsnotify_attach_connector_to_object(
Jan Kara08991e82017-02-01 09:21:58 +0100436 struct fsnotify_mark_connector __rcu **connp,
437 struct inode *inode,
438 struct vfsmount *mnt)
Jan Kara9dd813c2017-03-14 12:31:02 +0100439{
440 struct fsnotify_mark_connector *conn;
441
Jan Kara755b5bc2017-03-14 16:11:23 +0100442 conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
Jan Kara9dd813c2017-03-14 12:31:02 +0100443 if (!conn)
444 return -ENOMEM;
Jan Kara04662ca2017-02-01 08:19:43 +0100445 spin_lock_init(&conn->lock);
Jan Kara9dd813c2017-03-14 12:31:02 +0100446 INIT_HLIST_HEAD(&conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100447 if (inode) {
448 conn->flags = FSNOTIFY_OBJ_TYPE_INODE;
Jan Kara08991e82017-02-01 09:21:58 +0100449 conn->inode = igrab(inode);
Jan Kara86ffe242017-03-14 14:29:35 +0100450 } else {
451 conn->flags = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
452 conn->mnt = mnt;
453 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100454 /*
Jan Kara04662ca2017-02-01 08:19:43 +0100455 * cmpxchg() provides the barrier so that readers of *connp can see
456 * only initialized structure
Jan Kara9dd813c2017-03-14 12:31:02 +0100457 */
Jan Kara04662ca2017-02-01 08:19:43 +0100458 if (cmpxchg(connp, NULL, conn)) {
459 /* Someone else created list structure for us */
Jan Kara08991e82017-02-01 09:21:58 +0100460 if (inode)
461 iput(inode);
Jan Kara755b5bc2017-03-14 16:11:23 +0100462 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100463 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100464
465 return 0;
466}
467
468/*
Jan Kara08991e82017-02-01 09:21:58 +0100469 * 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
496/*
Jan Kara9dd813c2017-03-14 12:31:02 +0100497 * 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 */
Jan Kara755b5bc2017-03-14 16:11:23 +0100502static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
503 struct inode *inode, struct vfsmount *mnt,
504 int allow_dups)
Jan Kara0809ab62014-12-12 16:58:36 -0800505{
506 struct fsnotify_mark *lmark, *last = NULL;
Jan Kara9dd813c2017-03-14 12:31:02 +0100507 struct fsnotify_mark_connector *conn;
Jan Kara08991e82017-02-01 09:21:58 +0100508 struct fsnotify_mark_connector __rcu **connp;
Jan Kara0809ab62014-12-12 16:58:36 -0800509 int cmp;
Jan Kara755b5bc2017-03-14 16:11:23 +0100510 int err = 0;
511
512 if (WARN_ON(!inode && !mnt))
513 return -EINVAL;
Jan Kara04662ca2017-02-01 08:19:43 +0100514 if (inode)
Jan Kara755b5bc2017-03-14 16:11:23 +0100515 connp = &inode->i_fsnotify_marks;
Jan Kara04662ca2017-02-01 08:19:43 +0100516 else
Jan Kara755b5bc2017-03-14 16:11:23 +0100517 connp = &real_mount(mnt)->mnt_fsnotify_marks;
Jan Kara08991e82017-02-01 09:21:58 +0100518restart:
519 spin_lock(&mark->lock);
520 conn = fsnotify_grab_connector(connp);
521 if (!conn) {
522 spin_unlock(&mark->lock);
Jan Kara04662ca2017-02-01 08:19:43 +0100523 err = fsnotify_attach_connector_to_object(connp, inode, mnt);
Jan Kara9dd813c2017-03-14 12:31:02 +0100524 if (err)
525 return err;
Jan Kara08991e82017-02-01 09:21:58 +0100526 goto restart;
Jan Kara9dd813c2017-03-14 12:31:02 +0100527 }
Jan Kara0809ab62014-12-12 16:58:36 -0800528
529 /* is mark the first mark? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100530 if (hlist_empty(&conn->list)) {
531 hlist_add_head_rcu(&mark->obj_list, &conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100532 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800533 }
534
535 /* should mark be in the middle of the current list? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100536 hlist_for_each_entry(lmark, &conn->list, obj_list) {
Jan Kara0809ab62014-12-12 16:58:36 -0800537 last = lmark;
538
Jan Kara6b3f05d2016-12-21 12:15:30 +0100539 if ((lmark->group == mark->group) &&
540 (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
541 !allow_dups) {
Jan Kara755b5bc2017-03-14 16:11:23 +0100542 err = -EEXIST;
543 goto out_err;
544 }
Jan Kara0809ab62014-12-12 16:58:36 -0800545
546 cmp = fsnotify_compare_groups(lmark->group, mark->group);
547 if (cmp >= 0) {
548 hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100549 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800550 }
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);
Jan Kara86ffe242017-03-14 14:29:35 +0100556added:
557 mark->connector = conn;
Jan Kara755b5bc2017-03-14 16:11:23 +0100558out_err:
Jan Kara04662ca2017-02-01 08:19:43 +0100559 spin_unlock(&conn->lock);
Jan Kara755b5bc2017-03-14 16:11:23 +0100560 spin_unlock(&mark->lock);
561 return err;
Jan Kara0809ab62014-12-12 16:58:36 -0800562}
563
Jan Kara8edc6e12014-11-13 15:19:33 -0800564/*
Eric Paris5444e292009-12-17 21:24:27 -0500565 * 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 */
Jan Kara7b1293232016-12-21 18:32:48 +0100569int fsnotify_add_mark_locked(struct fsnotify_mark *mark, struct inode *inode,
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200570 struct vfsmount *mnt, int allow_dups)
Eric Paris5444e292009-12-17 21:24:27 -0500571{
Jan Kara7b1293232016-12-21 18:32:48 +0100572 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500573 int ret = 0;
574
Eric Paris5444e292009-12-17 21:24:27 -0500575 BUG_ON(inode && mnt);
576 BUG_ON(!inode && !mnt);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200577 BUG_ON(!mutex_is_locked(&group->mark_mutex));
Eric Paris5444e292009-12-17 21:24:27 -0500578
579 /*
Eric Paris5444e292009-12-17 21:24:27 -0500580 * LOCKING ORDER!!!!
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200581 * group->mark_mutex
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200582 * mark->lock
Jan Kara04662ca2017-02-01 08:19:43 +0100583 * mark->connector->lock
Eric Paris5444e292009-12-17 21:24:27 -0500584 */
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200585 spin_lock(&mark->lock);
Jan Kara4712e7222015-09-04 15:43:12 -0700586 mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris700307a2010-07-28 10:18:38 -0400587
Eric Paris5444e292009-12-17 21:24:27 -0500588 list_add(&mark->g_list, &group->marks_list);
589 atomic_inc(&group->num_marks);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100590 fsnotify_get_mark(mark); /* for g_list */
Eric Paris5444e292009-12-17 21:24:27 -0500591 spin_unlock(&mark->lock);
592
Jan Kara755b5bc2017-03-14 16:11:23 +0100593 ret = fsnotify_add_mark_list(mark, inode, mnt, allow_dups);
594 if (ret)
595 goto err;
596
Jan Karaa2426772017-03-15 09:16:27 +0100597 if (mark->mask)
598 fsnotify_recalc_mask(mark->connector);
Eric Paris5444e292009-12-17 21:24:27 -0500599
600 return ret;
601err:
Jan Kara11375142016-11-09 14:54:20 +0100602 mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
603 FSNOTIFY_MARK_FLAG_ATTACHED);
Eric Paris5444e292009-12-17 21:24:27 -0500604 list_del_init(&mark->g_list);
605 atomic_dec(&group->num_marks);
Eric Paris5444e292009-12-17 21:24:27 -0500606 spin_unlock(&mark->lock);
607
Jan Kara11375142016-11-09 14:54:20 +0100608 fsnotify_put_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500609 return ret;
610}
611
Jan Kara7b1293232016-12-21 18:32:48 +0100612int fsnotify_add_mark(struct fsnotify_mark *mark, struct inode *inode,
613 struct vfsmount *mnt, int allow_dups)
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200614{
615 int ret;
Jan Kara7b1293232016-12-21 18:32:48 +0100616 struct fsnotify_group *group = mark->group;
617
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200618 mutex_lock(&group->mark_mutex);
Jan Kara7b1293232016-12-21 18:32:48 +0100619 ret = fsnotify_add_mark_locked(mark, inode, mnt, allow_dups);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200620 mutex_unlock(&group->mark_mutex);
621 return ret;
622}
623
Eric Paris5444e292009-12-17 21:24:27 -0500624/*
Jan Kara0809ab62014-12-12 16:58:36 -0800625 * Given a list of marks, find the mark associated with given group. If found
626 * take a reference to that mark and return it, else return NULL.
627 */
Jan Kara08991e82017-02-01 09:21:58 +0100628struct fsnotify_mark *fsnotify_find_mark(
629 struct fsnotify_mark_connector __rcu **connp,
630 struct fsnotify_group *group)
Jan Kara0809ab62014-12-12 16:58:36 -0800631{
Jan Kara08991e82017-02-01 09:21:58 +0100632 struct fsnotify_mark_connector *conn;
Jan Kara0809ab62014-12-12 16:58:36 -0800633 struct fsnotify_mark *mark;
634
Jan Kara08991e82017-02-01 09:21:58 +0100635 conn = fsnotify_grab_connector(connp);
Jan Kara9dd813c2017-03-14 12:31:02 +0100636 if (!conn)
637 return NULL;
638
639 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara6b3f05d2016-12-21 12:15:30 +0100640 if (mark->group == group &&
641 (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Jan Kara0809ab62014-12-12 16:58:36 -0800642 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100643 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800644 return mark;
645 }
646 }
Jan Kara04662ca2017-02-01 08:19:43 +0100647 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800648 return NULL;
649}
650
Jan Kara18f2e0d2017-01-04 10:33:18 +0100651/* Clear any marks in a group with given type */
652void fsnotify_clear_marks_by_group(struct fsnotify_group *group,
653 unsigned int type)
Eric Paris5444e292009-12-17 21:24:27 -0500654{
655 struct fsnotify_mark *lmark, *mark;
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700656 LIST_HEAD(to_free);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100657 struct list_head *head = &to_free;
Eric Paris5444e292009-12-17 21:24:27 -0500658
Jan Kara2e37c6c2017-01-04 10:51:58 +0100659 /* Skip selection step if we want to clear all marks. */
660 if (type == FSNOTIFY_OBJ_ALL_TYPES) {
661 head = &group->marks_list;
662 goto clear;
663 }
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700664 /*
665 * We have to be really careful here. Anytime we drop mark_mutex, e.g.
666 * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
667 * to_free list so we have to use mark_mutex even when accessing that
668 * list. And freeing mark requires us to drop mark_mutex. So we can
669 * reliably free only the first mark in the list. That's why we first
670 * move marks to free to to_free list in one go and then free marks in
671 * to_free list one by one.
672 */
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200673 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Eric Paris5444e292009-12-17 21:24:27 -0500674 list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
Jan Kara18f2e0d2017-01-04 10:33:18 +0100675 if (mark->connector->flags & type)
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700676 list_move(&mark->g_list, &to_free);
Eric Paris5444e292009-12-17 21:24:27 -0500677 }
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200678 mutex_unlock(&group->mark_mutex);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700679
Jan Kara2e37c6c2017-01-04 10:51:58 +0100680clear:
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700681 while (1) {
682 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100683 if (list_empty(head)) {
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700684 mutex_unlock(&group->mark_mutex);
685 break;
686 }
Jan Kara2e37c6c2017-01-04 10:51:58 +0100687 mark = list_first_entry(head, struct fsnotify_mark, g_list);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700688 fsnotify_get_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700689 fsnotify_detach_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700690 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700691 fsnotify_free_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700692 fsnotify_put_mark(mark);
693 }
Eric Paris5444e292009-12-17 21:24:27 -0500694}
695
Jan Kara08991e82017-02-01 09:21:58 +0100696/* Destroy all marks attached to inode / vfsmount */
697void fsnotify_destroy_marks(struct fsnotify_mark_connector __rcu **connp)
Jan Kara0810b4f2017-02-01 09:23:48 +0100698{
Jan Kara08991e82017-02-01 09:21:58 +0100699 struct fsnotify_mark_connector *conn;
Jan Kara6b3f05d2016-12-21 12:15:30 +0100700 struct fsnotify_mark *mark, *old_mark = NULL;
701 struct inode *inode;
Jan Kara0810b4f2017-02-01 09:23:48 +0100702
Jan Kara6b3f05d2016-12-21 12:15:30 +0100703 conn = fsnotify_grab_connector(connp);
704 if (!conn)
705 return;
706 /*
707 * We have to be careful since we can race with e.g.
708 * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
709 * list can get modified. However we are holding mark reference and
710 * thus our mark cannot be removed from obj_list so we can continue
711 * iteration after regaining conn->lock.
712 */
713 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara0810b4f2017-02-01 09:23:48 +0100714 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100715 spin_unlock(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100716 if (old_mark)
717 fsnotify_put_mark(old_mark);
718 old_mark = mark;
Jan Kara0810b4f2017-02-01 09:23:48 +0100719 fsnotify_destroy_mark(mark, mark->group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100720 spin_lock(&conn->lock);
Jan Kara0810b4f2017-02-01 09:23:48 +0100721 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100722 /*
723 * Detach list from object now so that we don't pin inode until all
724 * mark references get dropped. It would lead to strange results such
725 * as delaying inode deletion or blocking unmount.
726 */
727 inode = fsnotify_detach_connector_from_object(conn);
728 spin_unlock(&conn->lock);
729 if (old_mark)
730 fsnotify_put_mark(old_mark);
731 iput(inode);
Jan Kara0810b4f2017-02-01 09:23:48 +0100732}
733
Eric Paris5444e292009-12-17 21:24:27 -0500734/*
735 * Nothing fancy, just initialize lists and locks and counters.
736 */
737void fsnotify_init_mark(struct fsnotify_mark *mark,
Jan Kara054c6362016-12-21 18:06:12 +0100738 struct fsnotify_group *group)
Eric Paris5444e292009-12-17 21:24:27 -0500739{
Eric Parisba643f02009-12-17 21:24:27 -0500740 memset(mark, 0, sizeof(*mark));
Eric Paris5444e292009-12-17 21:24:27 -0500741 spin_lock_init(&mark->lock);
742 atomic_set(&mark->refcnt, 1);
Jan Kara7b1293232016-12-21 18:32:48 +0100743 fsnotify_get_group(group);
744 mark->group = group;
Eric Paris5444e292009-12-17 21:24:27 -0500745}
Jeff Layton13d34ac2016-02-17 13:11:18 -0800746
Jan Kara35e48172016-05-19 17:08:59 -0700747/*
748 * Destroy all marks in destroy_list, waits for SRCU period to finish before
749 * actually freeing marks.
750 */
Jan Karaf09b04a2016-12-21 14:48:18 +0100751static void fsnotify_mark_destroy_workfn(struct work_struct *work)
Jeff Layton13d34ac2016-02-17 13:11:18 -0800752{
753 struct fsnotify_mark *mark, *next;
754 struct list_head private_destroy_list;
755
Jeff Layton0918f1c2016-02-17 13:11:21 -0800756 spin_lock(&destroy_lock);
757 /* exchange the list head */
758 list_replace_init(&destroy_list, &private_destroy_list);
759 spin_unlock(&destroy_lock);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800760
Jeff Layton0918f1c2016-02-17 13:11:21 -0800761 synchronize_srcu(&fsnotify_mark_srcu);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800762
Jeff Layton0918f1c2016-02-17 13:11:21 -0800763 list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
764 list_del_init(&mark->g_list);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100765 fsnotify_final_mark_destroy(mark);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800766 }
Jeff Layton13d34ac2016-02-17 13:11:18 -0800767}
Jan Kara35e48172016-05-19 17:08:59 -0700768
Jan Karaf09b04a2016-12-21 14:48:18 +0100769/* Wait for all marks queued for destruction to be actually destroyed */
770void fsnotify_wait_marks_destroyed(void)
Jan Kara35e48172016-05-19 17:08:59 -0700771{
Jan Karaf09b04a2016-12-21 14:48:18 +0100772 flush_delayed_work(&reaper_work);
Jan Kara35e48172016-05-19 17:08:59 -0700773}