blob: 7b595acd8ec91f07ece0c47dfbf0b648b6500d04 [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{
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300108 WARN_ON_ONCE(!refcount_read(&mark->refcnt));
109 refcount_inc(&mark->refcnt);
Eric Paris5444e292009-12-17 21:24:27 -0500110}
111
Jan Karaa2426772017-03-15 09:16:27 +0100112static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
Jan Kara0809ab62014-12-12 16:58:36 -0800113{
114 u32 new_mask = 0;
115 struct fsnotify_mark *mark;
116
Jan Kara04662ca2017-02-01 08:19:43 +0100117 assert_spin_locked(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100118 hlist_for_each_entry(mark, &conn->list, obj_list) {
119 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)
120 new_mask |= mark->mask;
121 }
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700122 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
Jan Karaa2426772017-03-15 09:16:27 +0100123 conn->inode->i_fsnotify_mask = new_mask;
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700124 else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT)
Jan Karaa2426772017-03-15 09:16:27 +0100125 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
Jan Kara6b3f05d2016-12-21 12:15:30 +0100130 * 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.
Jan Karaa2426772017-03-15 09:16:27 +0100133 */
134void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
135{
136 if (!conn)
137 return;
138
Jan Kara04662ca2017-02-01 08:19:43 +0100139 spin_lock(&conn->lock);
Jan Karaa2426772017-03-15 09:16:27 +0100140 __fsnotify_recalc_mask(conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100141 spin_unlock(&conn->lock);
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700142 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
Jan Karaa2426772017-03-15 09:16:27 +0100143 __fsnotify_update_child_dentry_flags(conn->inode);
Jan Kara0809ab62014-12-12 16:58:36 -0800144}
145
Jan Kara08991e82017-02-01 09:21:58 +0100146/* 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
Jan Kara08991e82017-02-01 09:21:58 +0100164static struct inode *fsnotify_detach_connector_from_object(
165 struct fsnotify_mark_connector *conn)
166{
167 struct inode *inode = NULL;
168
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700169 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE) {
Jan Kara08991e82017-02-01 09:21:58 +0100170 inode = conn->inode;
171 rcu_assign_pointer(inode->i_fsnotify_marks, NULL);
172 inode->i_fsnotify_mask = 0;
173 conn->inode = NULL;
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700174 conn->type = FSNOTIFY_OBJ_TYPE_DETACHED;
175 } else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
Jan Kara08991e82017-02-01 09:21:58 +0100176 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;
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700180 conn->type = FSNOTIFY_OBJ_TYPE_DETACHED;
Jan Kara08991e82017-02-01 09:21:58 +0100181 }
182
183 return inode;
184}
185
Jan Kara6b3f05d2016-12-21 12:15:30 +0100186static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
187{
Jan Kara054c6362016-12-21 18:06:12 +0100188 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);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100194}
195
196void fsnotify_put_mark(struct fsnotify_mark *mark)
Jan Kara8212a602017-03-15 09:48:11 +0100197{
198 struct fsnotify_mark_connector *conn;
199 struct inode *inode = NULL;
Jan Kara08991e82017-02-01 09:21:58 +0100200 bool free_conn = false;
Jan Kara8212a602017-03-15 09:48:11 +0100201
Jan Kara6b3f05d2016-12-21 12:15:30 +0100202 /* Catch marks that were actually never attached to object */
203 if (!mark->connector) {
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300204 if (refcount_dec_and_test(&mark->refcnt))
Jan Kara6b3f05d2016-12-21 12:15:30 +0100205 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 */
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300213 if (!refcount_dec_and_lock(&mark->refcnt, &mark->connector->lock))
Jan Kara6b3f05d2016-12-21 12:15:30 +0100214 return;
215
Jan Kara8212a602017-03-15 09:48:11 +0100216 conn = mark->connector;
Jan Kara8212a602017-03-15 09:48:11 +0100217 hlist_del_init_rcu(&mark->obj_list);
218 if (hlist_empty(&conn->list)) {
Jan Kara08991e82017-02-01 09:21:58 +0100219 inode = fsnotify_detach_connector_from_object(conn);
220 free_conn = true;
221 } else {
222 __fsnotify_recalc_mask(conn);
Jan Kara8212a602017-03-15 09:48:11 +0100223 }
224 mark->connector = NULL;
Jan Kara04662ca2017-02-01 08:19:43 +0100225 spin_unlock(&conn->lock);
Jan Kara8212a602017-03-15 09:48:11 +0100226
Jan Kara6b3f05d2016-12-21 12:15:30 +0100227 iput(inode);
228
Jan Kara08991e82017-02-01 09:21:58 +0100229 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 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100236 /*
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);
Jan Kara8212a602017-03-15 09:48:11 +0100247}
248
Miklos Szeredi24c20302017-10-30 21:14:55 +0100249/*
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)
Jan Karaabc77572016-11-10 16:02:11 +0100257{
Miklos Szeredi24c20302017-10-30 21:14:55 +0100258 if (!mark)
259 return true;
Jan Karaabc77572016-11-10 16:02:11 +0100260
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300261 if (refcount_inc_not_zero(&mark->refcnt)) {
Miklos Szeredi9a31d7a2017-10-30 21:14:56 +0100262 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 }
Miklos Szeredi24c20302017-10-30 21:14:55 +0100272 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);
Jan Karaabc77572016-11-10 16:02:11 +0100292 }
Miklos Szeredi24c20302017-10-30 21:14:55 +0100293}
294
295bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
296{
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700297 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;
Jan Karaabc77572016-11-10 16:02:11 +0100303 }
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;
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700313
314fail:
315 for (type--; type >= 0; type--)
316 fsnotify_put_mark_wake(iter_info->marks[type]);
317 return false;
Jan Karaabc77572016-11-10 16:02:11 +0100318}
319
320void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
321{
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700322 int type;
323
Jan Karaabc77572016-11-10 16:02:11 +0100324 iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700325 fsnotify_foreach_obj_type(type)
326 fsnotify_put_mark_wake(iter_info->marks[type]);
Jan Karaabc77572016-11-10 16:02:11 +0100327}
328
Eric Paris5444e292009-12-17 21:24:27 -0500329/*
Jan Kara6b3f05d2016-12-21 12:15:30 +0100330 * 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.
Jan Kara4712e7222015-09-04 15:43:12 -0700335 *
Jan Kara11375142016-11-09 14:54:20 +0100336 * 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.
Eric Paris5444e292009-12-17 21:24:27 -0500338 */
Jan Kara4712e7222015-09-04 15:43:12 -0700339void fsnotify_detach_mark(struct fsnotify_mark *mark)
Eric Paris5444e292009-12-17 21:24:27 -0500340{
Jan Kara4712e7222015-09-04 15:43:12 -0700341 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500342
Jan Kara11375142016-11-09 14:54:20 +0100343 WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
344 WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300345 refcount_read(&mark->refcnt) < 1 +
Jan Kara11375142016-11-09 14:54:20 +0100346 !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200347
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200348 spin_lock(&mark->lock);
Eric Paris700307a2010-07-28 10:18:38 -0400349 /* something else already called this function on this mark */
Jan Kara4712e7222015-09-04 15:43:12 -0700350 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Eric Paris5444e292009-12-17 21:24:27 -0500351 spin_unlock(&mark->lock);
Lino Sanfilippoe2a29942011-06-14 17:29:51 +0200352 return;
Eric Paris5444e292009-12-17 21:24:27 -0500353 }
Jan Kara4712e7222015-09-04 15:43:12 -0700354 mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris5444e292009-12-17 21:24:27 -0500355 list_del_init(&mark->g_list);
Eric Paris5444e292009-12-17 21:24:27 -0500356 spin_unlock(&mark->lock);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200357
Jan Kara4712e7222015-09-04 15:43:12 -0700358 atomic_dec(&group->num_marks);
Jan Kara11375142016-11-09 14:54:20 +0100359
360 /* Drop mark reference acquired in fsnotify_add_mark_locked() */
361 fsnotify_put_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700362}
363
364/*
Jan Kara11375142016-11-09 14:54:20 +0100365 * 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.
Jan Kara35e48172016-05-19 17:08:59 -0700368 *
Jan Kara11375142016-11-09 14:54:20 +0100369 * Caller must have a reference to the mark or be protected by
370 * fsnotify_mark_srcu.
Jan Kara4712e7222015-09-04 15:43:12 -0700371 */
Jan Kara11375142016-11-09 14:54:20 +0100372void fsnotify_free_mark(struct fsnotify_mark *mark)
Jan Kara4712e7222015-09-04 15:43:12 -0700373{
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);
Jan Kara11375142016-11-09 14:54:20 +0100380 return;
Jan Kara4712e7222015-09-04 15:43:12 -0700381 }
382 mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
383 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500384
Linus Torvaldsd725e662015-07-21 16:06:53 -0700385 /*
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);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200392}
393
394void fsnotify_destroy_mark(struct fsnotify_mark *mark,
395 struct fsnotify_group *group)
396{
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200397 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara4712e7222015-09-04 15:43:12 -0700398 fsnotify_detach_mark(mark);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200399 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700400 fsnotify_free_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500401}
402
403/*
Jan Kara8edc6e12014-11-13 15:19:33 -0800404 * 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
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300439static int fsnotify_attach_connector_to_object(fsnotify_connp_t *connp,
440 struct inode *inode,
441 struct vfsmount *mnt)
Jan Kara9dd813c2017-03-14 12:31:02 +0100442{
443 struct fsnotify_mark_connector *conn;
444
Jan Kara755b5bc2017-03-14 16:11:23 +0100445 conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
Jan Kara9dd813c2017-03-14 12:31:02 +0100446 if (!conn)
447 return -ENOMEM;
Jan Kara04662ca2017-02-01 08:19:43 +0100448 spin_lock_init(&conn->lock);
Jan Kara9dd813c2017-03-14 12:31:02 +0100449 INIT_HLIST_HEAD(&conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100450 if (inode) {
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700451 conn->type = FSNOTIFY_OBJ_TYPE_INODE;
Jan Kara08991e82017-02-01 09:21:58 +0100452 conn->inode = igrab(inode);
Jan Kara86ffe242017-03-14 14:29:35 +0100453 } else {
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700454 conn->type = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
Jan Kara86ffe242017-03-14 14:29:35 +0100455 conn->mnt = mnt;
456 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100457 /*
Jan Kara04662ca2017-02-01 08:19:43 +0100458 * cmpxchg() provides the barrier so that readers of *connp can see
459 * only initialized structure
Jan Kara9dd813c2017-03-14 12:31:02 +0100460 */
Jan Kara04662ca2017-02-01 08:19:43 +0100461 if (cmpxchg(connp, NULL, conn)) {
462 /* Someone else created list structure for us */
Jan Kara08991e82017-02-01 09:21:58 +0100463 if (inode)
464 iput(inode);
Jan Kara755b5bc2017-03-14 16:11:23 +0100465 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100466 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100467
468 return 0;
469}
470
471/*
Jan Kara08991e82017-02-01 09:21:58 +0100472 * Get mark connector, make sure it is alive and return with its lock held.
473 * This is for users that get connector pointer from inode or mount. Users that
474 * hold reference to a mark on the list may directly lock connector->lock as
475 * they are sure list cannot go away under them.
476 */
477static struct fsnotify_mark_connector *fsnotify_grab_connector(
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300478 fsnotify_connp_t *connp)
Jan Kara08991e82017-02-01 09:21:58 +0100479{
480 struct fsnotify_mark_connector *conn;
481 int idx;
482
483 idx = srcu_read_lock(&fsnotify_mark_srcu);
484 conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
485 if (!conn)
486 goto out;
487 spin_lock(&conn->lock);
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700488 if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED) {
Jan Kara08991e82017-02-01 09:21:58 +0100489 spin_unlock(&conn->lock);
490 srcu_read_unlock(&fsnotify_mark_srcu, idx);
491 return NULL;
492 }
493out:
494 srcu_read_unlock(&fsnotify_mark_srcu, idx);
495 return conn;
496}
497
498/*
Jan Kara9dd813c2017-03-14 12:31:02 +0100499 * Add mark into proper place in given list of marks. These marks may be used
500 * for the fsnotify backend to determine which event types should be delivered
501 * to which group and for which inodes. These marks are ordered according to
502 * priority, highest number first, and then by the group's location in memory.
503 */
Jan Kara755b5bc2017-03-14 16:11:23 +0100504static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
505 struct inode *inode, struct vfsmount *mnt,
506 int allow_dups)
Jan Kara0809ab62014-12-12 16:58:36 -0800507{
508 struct fsnotify_mark *lmark, *last = NULL;
Jan Kara9dd813c2017-03-14 12:31:02 +0100509 struct fsnotify_mark_connector *conn;
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300510 fsnotify_connp_t *connp;
Jan Kara0809ab62014-12-12 16:58:36 -0800511 int cmp;
Jan Kara755b5bc2017-03-14 16:11:23 +0100512 int err = 0;
513
514 if (WARN_ON(!inode && !mnt))
515 return -EINVAL;
Jan Kara04662ca2017-02-01 08:19:43 +0100516 if (inode)
Jan Kara755b5bc2017-03-14 16:11:23 +0100517 connp = &inode->i_fsnotify_marks;
Jan Kara04662ca2017-02-01 08:19:43 +0100518 else
Jan Kara755b5bc2017-03-14 16:11:23 +0100519 connp = &real_mount(mnt)->mnt_fsnotify_marks;
Jan Kara08991e82017-02-01 09:21:58 +0100520restart:
521 spin_lock(&mark->lock);
522 conn = fsnotify_grab_connector(connp);
523 if (!conn) {
524 spin_unlock(&mark->lock);
Jan Kara04662ca2017-02-01 08:19:43 +0100525 err = fsnotify_attach_connector_to_object(connp, inode, mnt);
Jan Kara9dd813c2017-03-14 12:31:02 +0100526 if (err)
527 return err;
Jan Kara08991e82017-02-01 09:21:58 +0100528 goto restart;
Jan Kara9dd813c2017-03-14 12:31:02 +0100529 }
Jan Kara0809ab62014-12-12 16:58:36 -0800530
531 /* is mark the first mark? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100532 if (hlist_empty(&conn->list)) {
533 hlist_add_head_rcu(&mark->obj_list, &conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100534 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800535 }
536
537 /* should mark be in the middle of the current list? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100538 hlist_for_each_entry(lmark, &conn->list, obj_list) {
Jan Kara0809ab62014-12-12 16:58:36 -0800539 last = lmark;
540
Jan Kara6b3f05d2016-12-21 12:15:30 +0100541 if ((lmark->group == mark->group) &&
542 (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
543 !allow_dups) {
Jan Kara755b5bc2017-03-14 16:11:23 +0100544 err = -EEXIST;
545 goto out_err;
546 }
Jan Kara0809ab62014-12-12 16:58:36 -0800547
548 cmp = fsnotify_compare_groups(lmark->group, mark->group);
549 if (cmp >= 0) {
550 hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100551 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800552 }
553 }
554
555 BUG_ON(last == NULL);
556 /* mark should be the last entry. last is the current last entry */
557 hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100558added:
559 mark->connector = conn;
Jan Kara755b5bc2017-03-14 16:11:23 +0100560out_err:
Jan Kara04662ca2017-02-01 08:19:43 +0100561 spin_unlock(&conn->lock);
Jan Kara755b5bc2017-03-14 16:11:23 +0100562 spin_unlock(&mark->lock);
563 return err;
Jan Kara0809ab62014-12-12 16:58:36 -0800564}
565
Jan Kara8edc6e12014-11-13 15:19:33 -0800566/*
Eric Paris5444e292009-12-17 21:24:27 -0500567 * Attach an initialized mark to a given group and fs object.
568 * These marks may be used for the fsnotify backend to determine which
569 * event types should be delivered to which group.
570 */
Jan Kara7b129322016-12-21 18:32:48 +0100571int fsnotify_add_mark_locked(struct fsnotify_mark *mark, struct inode *inode,
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200572 struct vfsmount *mnt, int allow_dups)
Eric Paris5444e292009-12-17 21:24:27 -0500573{
Jan Kara7b129322016-12-21 18:32:48 +0100574 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500575 int ret = 0;
576
Eric Paris5444e292009-12-17 21:24:27 -0500577 BUG_ON(inode && mnt);
578 BUG_ON(!inode && !mnt);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200579 BUG_ON(!mutex_is_locked(&group->mark_mutex));
Eric Paris5444e292009-12-17 21:24:27 -0500580
581 /*
Eric Paris5444e292009-12-17 21:24:27 -0500582 * LOCKING ORDER!!!!
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200583 * group->mark_mutex
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200584 * mark->lock
Jan Kara04662ca2017-02-01 08:19:43 +0100585 * mark->connector->lock
Eric Paris5444e292009-12-17 21:24:27 -0500586 */
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200587 spin_lock(&mark->lock);
Jan Kara4712e7222015-09-04 15:43:12 -0700588 mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris700307a2010-07-28 10:18:38 -0400589
Eric Paris5444e292009-12-17 21:24:27 -0500590 list_add(&mark->g_list, &group->marks_list);
591 atomic_inc(&group->num_marks);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100592 fsnotify_get_mark(mark); /* for g_list */
Eric Paris5444e292009-12-17 21:24:27 -0500593 spin_unlock(&mark->lock);
594
Jan Kara755b5bc2017-03-14 16:11:23 +0100595 ret = fsnotify_add_mark_list(mark, inode, mnt, allow_dups);
596 if (ret)
597 goto err;
598
Jan Karaa2426772017-03-15 09:16:27 +0100599 if (mark->mask)
600 fsnotify_recalc_mask(mark->connector);
Eric Paris5444e292009-12-17 21:24:27 -0500601
602 return ret;
603err:
Jan Kara9cf90ce2017-10-31 10:09:25 +0100604 spin_lock(&mark->lock);
Jan Kara11375142016-11-09 14:54:20 +0100605 mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
606 FSNOTIFY_MARK_FLAG_ATTACHED);
Eric Paris5444e292009-12-17 21:24:27 -0500607 list_del_init(&mark->g_list);
Jan Kara9cf90ce2017-10-31 10:09:25 +0100608 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500609 atomic_dec(&group->num_marks);
Eric Paris5444e292009-12-17 21:24:27 -0500610
Jan Kara11375142016-11-09 14:54:20 +0100611 fsnotify_put_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500612 return ret;
613}
614
Jan Kara7b129322016-12-21 18:32:48 +0100615int fsnotify_add_mark(struct fsnotify_mark *mark, struct inode *inode,
616 struct vfsmount *mnt, int allow_dups)
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200617{
618 int ret;
Jan Kara7b129322016-12-21 18:32:48 +0100619 struct fsnotify_group *group = mark->group;
620
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200621 mutex_lock(&group->mark_mutex);
Jan Kara7b129322016-12-21 18:32:48 +0100622 ret = fsnotify_add_mark_locked(mark, inode, mnt, allow_dups);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200623 mutex_unlock(&group->mark_mutex);
624 return ret;
625}
626
Eric Paris5444e292009-12-17 21:24:27 -0500627/*
Jan Kara0809ab62014-12-12 16:58:36 -0800628 * Given a list of marks, find the mark associated with given group. If found
629 * take a reference to that mark and return it, else return NULL.
630 */
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300631struct fsnotify_mark *fsnotify_find_mark(fsnotify_connp_t *connp,
632 struct fsnotify_group *group)
Jan Kara0809ab62014-12-12 16:58:36 -0800633{
Jan Kara08991e82017-02-01 09:21:58 +0100634 struct fsnotify_mark_connector *conn;
Jan Kara0809ab62014-12-12 16:58:36 -0800635 struct fsnotify_mark *mark;
636
Jan Kara08991e82017-02-01 09:21:58 +0100637 conn = fsnotify_grab_connector(connp);
Jan Kara9dd813c2017-03-14 12:31:02 +0100638 if (!conn)
639 return NULL;
640
641 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara6b3f05d2016-12-21 12:15:30 +0100642 if (mark->group == group &&
643 (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Jan Kara0809ab62014-12-12 16:58:36 -0800644 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100645 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800646 return mark;
647 }
648 }
Jan Kara04662ca2017-02-01 08:19:43 +0100649 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800650 return NULL;
651}
652
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700653/* Clear any marks in a group with given type mask */
Jan Kara18f2e0d2017-01-04 10:33:18 +0100654void fsnotify_clear_marks_by_group(struct fsnotify_group *group,
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700655 unsigned int type_mask)
Eric Paris5444e292009-12-17 21:24:27 -0500656{
657 struct fsnotify_mark *lmark, *mark;
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700658 LIST_HEAD(to_free);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100659 struct list_head *head = &to_free;
Eric Paris5444e292009-12-17 21:24:27 -0500660
Jan Kara2e37c6c2017-01-04 10:51:58 +0100661 /* Skip selection step if we want to clear all marks. */
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700662 if (type_mask == FSNOTIFY_OBJ_ALL_TYPES_MASK) {
Jan Kara2e37c6c2017-01-04 10:51:58 +0100663 head = &group->marks_list;
664 goto clear;
665 }
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700666 /*
667 * We have to be really careful here. Anytime we drop mark_mutex, e.g.
668 * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
669 * to_free list so we have to use mark_mutex even when accessing that
670 * list. And freeing mark requires us to drop mark_mutex. So we can
671 * reliably free only the first mark in the list. That's why we first
672 * move marks to free to to_free list in one go and then free marks in
673 * to_free list one by one.
674 */
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200675 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Eric Paris5444e292009-12-17 21:24:27 -0500676 list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700677 if ((1U << mark->connector->type) & type_mask)
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700678 list_move(&mark->g_list, &to_free);
Eric Paris5444e292009-12-17 21:24:27 -0500679 }
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200680 mutex_unlock(&group->mark_mutex);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700681
Jan Kara2e37c6c2017-01-04 10:51:58 +0100682clear:
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700683 while (1) {
684 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100685 if (list_empty(head)) {
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700686 mutex_unlock(&group->mark_mutex);
687 break;
688 }
Jan Kara2e37c6c2017-01-04 10:51:58 +0100689 mark = list_first_entry(head, struct fsnotify_mark, g_list);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700690 fsnotify_get_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700691 fsnotify_detach_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700692 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700693 fsnotify_free_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700694 fsnotify_put_mark(mark);
695 }
Eric Paris5444e292009-12-17 21:24:27 -0500696}
697
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300698/* Destroy all marks attached to an object via connector */
699void fsnotify_destroy_marks(fsnotify_connp_t *connp)
Jan Kara0810b4f2017-02-01 09:23:48 +0100700{
Jan Kara08991e82017-02-01 09:21:58 +0100701 struct fsnotify_mark_connector *conn;
Jan Kara6b3f05d2016-12-21 12:15:30 +0100702 struct fsnotify_mark *mark, *old_mark = NULL;
703 struct inode *inode;
Jan Kara0810b4f2017-02-01 09:23:48 +0100704
Jan Kara6b3f05d2016-12-21 12:15:30 +0100705 conn = fsnotify_grab_connector(connp);
706 if (!conn)
707 return;
708 /*
709 * We have to be careful since we can race with e.g.
710 * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
711 * list can get modified. However we are holding mark reference and
712 * thus our mark cannot be removed from obj_list so we can continue
713 * iteration after regaining conn->lock.
714 */
715 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara0810b4f2017-02-01 09:23:48 +0100716 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100717 spin_unlock(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100718 if (old_mark)
719 fsnotify_put_mark(old_mark);
720 old_mark = mark;
Jan Kara0810b4f2017-02-01 09:23:48 +0100721 fsnotify_destroy_mark(mark, mark->group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100722 spin_lock(&conn->lock);
Jan Kara0810b4f2017-02-01 09:23:48 +0100723 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100724 /*
725 * Detach list from object now so that we don't pin inode until all
726 * mark references get dropped. It would lead to strange results such
727 * as delaying inode deletion or blocking unmount.
728 */
729 inode = fsnotify_detach_connector_from_object(conn);
730 spin_unlock(&conn->lock);
731 if (old_mark)
732 fsnotify_put_mark(old_mark);
733 iput(inode);
Jan Kara0810b4f2017-02-01 09:23:48 +0100734}
735
Eric Paris5444e292009-12-17 21:24:27 -0500736/*
737 * Nothing fancy, just initialize lists and locks and counters.
738 */
739void fsnotify_init_mark(struct fsnotify_mark *mark,
Jan Kara054c6362016-12-21 18:06:12 +0100740 struct fsnotify_group *group)
Eric Paris5444e292009-12-17 21:24:27 -0500741{
Eric Parisba643f02009-12-17 21:24:27 -0500742 memset(mark, 0, sizeof(*mark));
Eric Paris5444e292009-12-17 21:24:27 -0500743 spin_lock_init(&mark->lock);
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300744 refcount_set(&mark->refcnt, 1);
Jan Kara7b129322016-12-21 18:32:48 +0100745 fsnotify_get_group(group);
746 mark->group = group;
Eric Paris5444e292009-12-17 21:24:27 -0500747}
Jeff Layton13d34ac2016-02-17 13:11:18 -0800748
Jan Kara35e48172016-05-19 17:08:59 -0700749/*
750 * Destroy all marks in destroy_list, waits for SRCU period to finish before
751 * actually freeing marks.
752 */
Jan Karaf09b04a2016-12-21 14:48:18 +0100753static void fsnotify_mark_destroy_workfn(struct work_struct *work)
Jeff Layton13d34ac2016-02-17 13:11:18 -0800754{
755 struct fsnotify_mark *mark, *next;
756 struct list_head private_destroy_list;
757
Jeff Layton0918f1c2016-02-17 13:11:21 -0800758 spin_lock(&destroy_lock);
759 /* exchange the list head */
760 list_replace_init(&destroy_list, &private_destroy_list);
761 spin_unlock(&destroy_lock);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800762
Jeff Layton0918f1c2016-02-17 13:11:21 -0800763 synchronize_srcu(&fsnotify_mark_srcu);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800764
Jeff Layton0918f1c2016-02-17 13:11:21 -0800765 list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
766 list_del_init(&mark->g_list);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100767 fsnotify_final_mark_destroy(mark);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800768 }
Jeff Layton13d34ac2016-02-17 13:11:18 -0800769}
Jan Kara35e48172016-05-19 17:08:59 -0700770
Jan Karaf09b04a2016-12-21 14:48:18 +0100771/* Wait for all marks queued for destruction to be actually destroyed */
772void fsnotify_wait_marks_destroyed(void)
Jan Kara35e48172016-05-19 17:08:59 -0700773{
Jan Karaf09b04a2016-12-21 14:48:18 +0100774 flush_delayed_work(&reaper_work);
Jan Kara35e48172016-05-19 17:08:59 -0700775}