blob: 959bc73aaae73989a2c0646ad04c150ef7c49d32 [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)
Amir Goldstein36f10f52018-06-23 17:54:49 +0300123 fsnotify_conn_inode(conn)->i_fsnotify_mask = new_mask;
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700124 else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT)
Amir Goldstein36f10f52018-06-23 17:54:49 +0300125 fsnotify_conn_mount(conn)->mnt_fsnotify_mask = new_mask;
Jan Karaa2426772017-03-15 09:16:27 +0100126}
127
128/*
129 * Calculate mask of events for a list of marks. The caller must make sure
Amir Goldstein36f10f52018-06-23 17:54:49 +0300130 * connector and connector->obj cannot disappear under us. Callers achieve
Jan Kara6b3f05d2016-12-21 12:15:30 +0100131 * 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)
Amir Goldstein36f10f52018-06-23 17:54:49 +0300143 __fsnotify_update_child_dentry_flags(
144 fsnotify_conn_inode(conn));
Jan Kara0809ab62014-12-12 16:58:36 -0800145}
146
Jan Kara08991e82017-02-01 09:21:58 +0100147/* Free all connectors queued for freeing once SRCU period ends */
148static void fsnotify_connector_destroy_workfn(struct work_struct *work)
149{
150 struct fsnotify_mark_connector *conn, *free;
151
152 spin_lock(&destroy_lock);
153 conn = connector_destroy_list;
154 connector_destroy_list = NULL;
155 spin_unlock(&destroy_lock);
156
157 synchronize_srcu(&fsnotify_mark_srcu);
158 while (conn) {
159 free = conn;
160 conn = conn->destroy_next;
161 kmem_cache_free(fsnotify_mark_connector_cachep, free);
162 }
163}
164
Jan Kara08991e82017-02-01 09:21:58 +0100165static struct inode *fsnotify_detach_connector_from_object(
166 struct fsnotify_mark_connector *conn)
167{
168 struct inode *inode = NULL;
169
Amir Goldstein36f10f52018-06-23 17:54:49 +0300170 if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED)
171 return NULL;
172
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700173 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE) {
Amir Goldstein36f10f52018-06-23 17:54:49 +0300174 inode = fsnotify_conn_inode(conn);
Jan Kara08991e82017-02-01 09:21:58 +0100175 inode->i_fsnotify_mask = 0;
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700176 } else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
Amir Goldstein36f10f52018-06-23 17:54:49 +0300177 fsnotify_conn_mount(conn)->mnt_fsnotify_mask = 0;
Jan Kara08991e82017-02-01 09:21:58 +0100178 }
179
Amir Goldstein36f10f52018-06-23 17:54:49 +0300180 rcu_assign_pointer(*(conn->obj), NULL);
181 conn->obj = NULL;
182 conn->type = FSNOTIFY_OBJ_TYPE_DETACHED;
183
Jan Kara08991e82017-02-01 09:21:58 +0100184 return inode;
185}
186
Jan Kara6b3f05d2016-12-21 12:15:30 +0100187static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
188{
Jan Kara054c6362016-12-21 18:06:12 +0100189 struct fsnotify_group *group = mark->group;
190
191 if (WARN_ON_ONCE(!group))
192 return;
193 group->ops->free_mark(mark);
194 fsnotify_put_group(group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100195}
196
197void fsnotify_put_mark(struct fsnotify_mark *mark)
Jan Kara8212a602017-03-15 09:48:11 +0100198{
199 struct fsnotify_mark_connector *conn;
200 struct inode *inode = NULL;
Jan Kara08991e82017-02-01 09:21:58 +0100201 bool free_conn = false;
Jan Kara8212a602017-03-15 09:48:11 +0100202
Jan Kara6b3f05d2016-12-21 12:15:30 +0100203 /* Catch marks that were actually never attached to object */
204 if (!mark->connector) {
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300205 if (refcount_dec_and_test(&mark->refcnt))
Jan Kara6b3f05d2016-12-21 12:15:30 +0100206 fsnotify_final_mark_destroy(mark);
207 return;
208 }
209
210 /*
211 * We have to be careful so that traversals of obj_list under lock can
212 * safely grab mark reference.
213 */
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300214 if (!refcount_dec_and_lock(&mark->refcnt, &mark->connector->lock))
Jan Kara6b3f05d2016-12-21 12:15:30 +0100215 return;
216
Jan Kara8212a602017-03-15 09:48:11 +0100217 conn = mark->connector;
Jan Kara8212a602017-03-15 09:48:11 +0100218 hlist_del_init_rcu(&mark->obj_list);
219 if (hlist_empty(&conn->list)) {
Jan Kara08991e82017-02-01 09:21:58 +0100220 inode = fsnotify_detach_connector_from_object(conn);
221 free_conn = true;
222 } else {
223 __fsnotify_recalc_mask(conn);
Jan Kara8212a602017-03-15 09:48:11 +0100224 }
225 mark->connector = NULL;
Jan Kara04662ca2017-02-01 08:19:43 +0100226 spin_unlock(&conn->lock);
Jan Kara8212a602017-03-15 09:48:11 +0100227
Jan Kara6b3f05d2016-12-21 12:15:30 +0100228 iput(inode);
229
Jan Kara08991e82017-02-01 09:21:58 +0100230 if (free_conn) {
231 spin_lock(&destroy_lock);
232 conn->destroy_next = connector_destroy_list;
233 connector_destroy_list = conn;
234 spin_unlock(&destroy_lock);
235 queue_work(system_unbound_wq, &connector_reaper_work);
236 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100237 /*
238 * Note that we didn't update flags telling whether inode cares about
239 * what's happening with children. We update these flags from
240 * __fsnotify_parent() lazily when next event happens on one of our
241 * children.
242 */
243 spin_lock(&destroy_lock);
244 list_add(&mark->g_list, &destroy_list);
245 spin_unlock(&destroy_lock);
246 queue_delayed_work(system_unbound_wq, &reaper_work,
247 FSNOTIFY_REAPER_DELAY);
Jan Kara8212a602017-03-15 09:48:11 +0100248}
249
Miklos Szeredi24c20302017-10-30 21:14:55 +0100250/*
251 * Get mark reference when we found the mark via lockless traversal of object
252 * list. Mark can be already removed from the list by now and on its way to be
253 * destroyed once SRCU period ends.
254 *
255 * Also pin the group so it doesn't disappear under us.
256 */
257static bool fsnotify_get_mark_safe(struct fsnotify_mark *mark)
Jan Karaabc77572016-11-10 16:02:11 +0100258{
Miklos Szeredi24c20302017-10-30 21:14:55 +0100259 if (!mark)
260 return true;
Jan Karaabc77572016-11-10 16:02:11 +0100261
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300262 if (refcount_inc_not_zero(&mark->refcnt)) {
Miklos Szeredi9a31d7a2017-10-30 21:14:56 +0100263 spin_lock(&mark->lock);
264 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) {
265 /* mark is attached, group is still alive then */
266 atomic_inc(&mark->group->user_waits);
267 spin_unlock(&mark->lock);
268 return true;
269 }
270 spin_unlock(&mark->lock);
271 fsnotify_put_mark(mark);
272 }
Miklos Szeredi24c20302017-10-30 21:14:55 +0100273 return false;
274}
275
276/*
277 * Puts marks and wakes up group destruction if necessary.
278 *
279 * Pairs with fsnotify_get_mark_safe()
280 */
281static void fsnotify_put_mark_wake(struct fsnotify_mark *mark)
282{
283 if (mark) {
284 struct fsnotify_group *group = mark->group;
285
286 fsnotify_put_mark(mark);
287 /*
288 * We abuse notification_waitq on group shutdown for waiting for
289 * all marks pinned when waiting for userspace.
290 */
291 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
292 wake_up(&group->notification_waitq);
Jan Karaabc77572016-11-10 16:02:11 +0100293 }
Miklos Szeredi24c20302017-10-30 21:14:55 +0100294}
295
296bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
297{
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700298 int type;
299
300 fsnotify_foreach_obj_type(type) {
301 /* This can fail if mark is being removed */
302 if (!fsnotify_get_mark_safe(iter_info->marks[type]))
303 goto fail;
Jan Karaabc77572016-11-10 16:02:11 +0100304 }
305
306 /*
307 * Now that both marks are pinned by refcount in the inode / vfsmount
308 * lists, we can drop SRCU lock, and safely resume the list iteration
309 * once userspace returns.
310 */
311 srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
312
313 return true;
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700314
315fail:
316 for (type--; type >= 0; type--)
317 fsnotify_put_mark_wake(iter_info->marks[type]);
318 return false;
Jan Karaabc77572016-11-10 16:02:11 +0100319}
320
321void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
322{
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700323 int type;
324
Jan Karaabc77572016-11-10 16:02:11 +0100325 iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700326 fsnotify_foreach_obj_type(type)
327 fsnotify_put_mark_wake(iter_info->marks[type]);
Jan Karaabc77572016-11-10 16:02:11 +0100328}
329
Eric Paris5444e292009-12-17 21:24:27 -0500330/*
Jan Kara6b3f05d2016-12-21 12:15:30 +0100331 * Mark mark as detached, remove it from group list. Mark still stays in object
332 * list until its last reference is dropped. Note that we rely on mark being
333 * removed from group list before corresponding reference to it is dropped. In
334 * particular we rely on mark->connector being valid while we hold
335 * group->mark_mutex if we found the mark through g_list.
Jan Kara4712e7222015-09-04 15:43:12 -0700336 *
Jan Kara11375142016-11-09 14:54:20 +0100337 * Must be called with group->mark_mutex held. The caller must either hold
338 * reference to the mark or be protected by fsnotify_mark_srcu.
Eric Paris5444e292009-12-17 21:24:27 -0500339 */
Jan Kara4712e7222015-09-04 15:43:12 -0700340void fsnotify_detach_mark(struct fsnotify_mark *mark)
Eric Paris5444e292009-12-17 21:24:27 -0500341{
Jan Kara4712e7222015-09-04 15:43:12 -0700342 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500343
Jan Kara11375142016-11-09 14:54:20 +0100344 WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
345 WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300346 refcount_read(&mark->refcnt) < 1 +
Jan Kara11375142016-11-09 14:54:20 +0100347 !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200348
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200349 spin_lock(&mark->lock);
Eric Paris700307a2010-07-28 10:18:38 -0400350 /* something else already called this function on this mark */
Jan Kara4712e7222015-09-04 15:43:12 -0700351 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Eric Paris5444e292009-12-17 21:24:27 -0500352 spin_unlock(&mark->lock);
Lino Sanfilippoe2a29942011-06-14 17:29:51 +0200353 return;
Eric Paris5444e292009-12-17 21:24:27 -0500354 }
Jan Kara4712e7222015-09-04 15:43:12 -0700355 mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris5444e292009-12-17 21:24:27 -0500356 list_del_init(&mark->g_list);
Eric Paris5444e292009-12-17 21:24:27 -0500357 spin_unlock(&mark->lock);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200358
Jan Kara4712e7222015-09-04 15:43:12 -0700359 atomic_dec(&group->num_marks);
Jan Kara11375142016-11-09 14:54:20 +0100360
361 /* Drop mark reference acquired in fsnotify_add_mark_locked() */
362 fsnotify_put_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700363}
364
365/*
Jan Kara11375142016-11-09 14:54:20 +0100366 * Free fsnotify mark. The mark is actually only marked as being freed. The
367 * freeing is actually happening only once last reference to the mark is
368 * dropped from a workqueue which first waits for srcu period end.
Jan Kara35e48172016-05-19 17:08:59 -0700369 *
Jan Kara11375142016-11-09 14:54:20 +0100370 * Caller must have a reference to the mark or be protected by
371 * fsnotify_mark_srcu.
Jan Kara4712e7222015-09-04 15:43:12 -0700372 */
Jan Kara11375142016-11-09 14:54:20 +0100373void fsnotify_free_mark(struct fsnotify_mark *mark)
Jan Kara4712e7222015-09-04 15:43:12 -0700374{
375 struct fsnotify_group *group = mark->group;
376
377 spin_lock(&mark->lock);
378 /* something else already called this function on this mark */
379 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
380 spin_unlock(&mark->lock);
Jan Kara11375142016-11-09 14:54:20 +0100381 return;
Jan Kara4712e7222015-09-04 15:43:12 -0700382 }
383 mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
384 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500385
Linus Torvaldsd725e662015-07-21 16:06:53 -0700386 /*
387 * Some groups like to know that marks are being freed. This is a
388 * callback to the group function to let it know that this mark
389 * is being freed.
390 */
391 if (group->ops->freeing_mark)
392 group->ops->freeing_mark(mark, group);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200393}
394
395void fsnotify_destroy_mark(struct fsnotify_mark *mark,
396 struct fsnotify_group *group)
397{
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200398 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara4712e7222015-09-04 15:43:12 -0700399 fsnotify_detach_mark(mark);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200400 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700401 fsnotify_free_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500402}
403
404/*
Jan Kara8edc6e12014-11-13 15:19:33 -0800405 * Sorting function for lists of fsnotify marks.
406 *
407 * Fanotify supports different notification classes (reflected as priority of
408 * notification group). Events shall be passed to notification groups in
409 * decreasing priority order. To achieve this marks in notification lists for
410 * inodes and vfsmounts are sorted so that priorities of corresponding groups
411 * are descending.
412 *
413 * Furthermore correct handling of the ignore mask requires processing inode
414 * and vfsmount marks of each group together. Using the group address as
415 * further sort criterion provides a unique sorting order and thus we can
416 * merge inode and vfsmount lists of marks in linear time and find groups
417 * present in both lists.
418 *
419 * A return value of 1 signifies that b has priority over a.
420 * A return value of 0 signifies that the two marks have to be handled together.
421 * A return value of -1 signifies that a has priority over b.
422 */
423int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
424{
425 if (a == b)
426 return 0;
427 if (!a)
428 return 1;
429 if (!b)
430 return -1;
431 if (a->priority < b->priority)
432 return 1;
433 if (a->priority > b->priority)
434 return -1;
435 if (a < b)
436 return 1;
437 return -1;
438}
439
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300440static int fsnotify_attach_connector_to_object(fsnotify_connp_t *connp,
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300441 unsigned int type)
Jan Kara9dd813c2017-03-14 12:31:02 +0100442{
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300443 struct inode *inode = NULL;
Jan Kara9dd813c2017-03-14 12:31:02 +0100444 struct fsnotify_mark_connector *conn;
445
Jan Kara755b5bc2017-03-14 16:11:23 +0100446 conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
Jan Kara9dd813c2017-03-14 12:31:02 +0100447 if (!conn)
448 return -ENOMEM;
Jan Kara04662ca2017-02-01 08:19:43 +0100449 spin_lock_init(&conn->lock);
Jan Kara9dd813c2017-03-14 12:31:02 +0100450 INIT_HLIST_HEAD(&conn->list);
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300451 conn->type = type;
Amir Goldstein36f10f52018-06-23 17:54:49 +0300452 conn->obj = connp;
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300453 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
Amir Goldstein36f10f52018-06-23 17:54:49 +0300454 inode = igrab(fsnotify_conn_inode(conn));
Jan Kara9dd813c2017-03-14 12:31:02 +0100455 /*
Jan Kara04662ca2017-02-01 08:19:43 +0100456 * cmpxchg() provides the barrier so that readers of *connp can see
457 * only initialized structure
Jan Kara9dd813c2017-03-14 12:31:02 +0100458 */
Jan Kara04662ca2017-02-01 08:19:43 +0100459 if (cmpxchg(connp, NULL, conn)) {
460 /* Someone else created list structure for us */
Jan Kara08991e82017-02-01 09:21:58 +0100461 if (inode)
462 iput(inode);
Jan Kara755b5bc2017-03-14 16:11:23 +0100463 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100464 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100465
466 return 0;
467}
468
469/*
Jan Kara08991e82017-02-01 09:21:58 +0100470 * Get mark connector, make sure it is alive and return with its lock held.
471 * This is for users that get connector pointer from inode or mount. Users that
472 * hold reference to a mark on the list may directly lock connector->lock as
473 * they are sure list cannot go away under them.
474 */
475static struct fsnotify_mark_connector *fsnotify_grab_connector(
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300476 fsnotify_connp_t *connp)
Jan Kara08991e82017-02-01 09:21:58 +0100477{
478 struct fsnotify_mark_connector *conn;
479 int idx;
480
481 idx = srcu_read_lock(&fsnotify_mark_srcu);
482 conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
483 if (!conn)
484 goto out;
485 spin_lock(&conn->lock);
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700486 if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED) {
Jan Kara08991e82017-02-01 09:21:58 +0100487 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,
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300503 fsnotify_connp_t *connp, unsigned int type,
Jan Kara755b5bc2017-03-14 16:11:23 +0100504 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 Kara0809ab62014-12-12 16:58:36 -0800508 int cmp;
Jan Kara755b5bc2017-03-14 16:11:23 +0100509 int err = 0;
510
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300511 if (WARN_ON(!fsnotify_valid_obj_type(type)))
Jan Kara755b5bc2017-03-14 16:11:23 +0100512 return -EINVAL;
Jan Kara08991e82017-02-01 09:21:58 +0100513restart:
514 spin_lock(&mark->lock);
515 conn = fsnotify_grab_connector(connp);
516 if (!conn) {
517 spin_unlock(&mark->lock);
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300518 err = fsnotify_attach_connector_to_object(connp, type);
Jan Kara9dd813c2017-03-14 12:31:02 +0100519 if (err)
520 return err;
Jan Kara08991e82017-02-01 09:21:58 +0100521 goto restart;
Jan Kara9dd813c2017-03-14 12:31:02 +0100522 }
Jan Kara0809ab62014-12-12 16:58:36 -0800523
524 /* is mark the first mark? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100525 if (hlist_empty(&conn->list)) {
526 hlist_add_head_rcu(&mark->obj_list, &conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100527 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800528 }
529
530 /* should mark be in the middle of the current list? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100531 hlist_for_each_entry(lmark, &conn->list, obj_list) {
Jan Kara0809ab62014-12-12 16:58:36 -0800532 last = lmark;
533
Jan Kara6b3f05d2016-12-21 12:15:30 +0100534 if ((lmark->group == mark->group) &&
535 (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
536 !allow_dups) {
Jan Kara755b5bc2017-03-14 16:11:23 +0100537 err = -EEXIST;
538 goto out_err;
539 }
Jan Kara0809ab62014-12-12 16:58:36 -0800540
541 cmp = fsnotify_compare_groups(lmark->group, mark->group);
542 if (cmp >= 0) {
543 hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100544 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800545 }
546 }
547
548 BUG_ON(last == NULL);
549 /* mark should be the last entry. last is the current last entry */
550 hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100551added:
552 mark->connector = conn;
Jan Kara755b5bc2017-03-14 16:11:23 +0100553out_err:
Jan Kara04662ca2017-02-01 08:19:43 +0100554 spin_unlock(&conn->lock);
Jan Kara755b5bc2017-03-14 16:11:23 +0100555 spin_unlock(&mark->lock);
556 return err;
Jan Kara0809ab62014-12-12 16:58:36 -0800557}
558
Jan Kara8edc6e12014-11-13 15:19:33 -0800559/*
Eric Paris5444e292009-12-17 21:24:27 -0500560 * Attach an initialized mark to a given group and fs object.
561 * These marks may be used for the fsnotify backend to determine which
562 * event types should be delivered to which group.
563 */
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300564int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
565 fsnotify_connp_t *connp, unsigned int type,
566 int allow_dups)
Eric Paris5444e292009-12-17 21:24:27 -0500567{
Jan Kara7b1293232016-12-21 18:32:48 +0100568 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500569 int ret = 0;
570
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200571 BUG_ON(!mutex_is_locked(&group->mark_mutex));
Eric Paris5444e292009-12-17 21:24:27 -0500572
573 /*
Eric Paris5444e292009-12-17 21:24:27 -0500574 * LOCKING ORDER!!!!
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200575 * group->mark_mutex
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200576 * mark->lock
Jan Kara04662ca2017-02-01 08:19:43 +0100577 * mark->connector->lock
Eric Paris5444e292009-12-17 21:24:27 -0500578 */
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200579 spin_lock(&mark->lock);
Jan Kara4712e7222015-09-04 15:43:12 -0700580 mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris700307a2010-07-28 10:18:38 -0400581
Eric Paris5444e292009-12-17 21:24:27 -0500582 list_add(&mark->g_list, &group->marks_list);
583 atomic_inc(&group->num_marks);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100584 fsnotify_get_mark(mark); /* for g_list */
Eric Paris5444e292009-12-17 21:24:27 -0500585 spin_unlock(&mark->lock);
586
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300587 ret = fsnotify_add_mark_list(mark, connp, type, allow_dups);
Jan Kara755b5bc2017-03-14 16:11:23 +0100588 if (ret)
589 goto err;
590
Jan Karaa2426772017-03-15 09:16:27 +0100591 if (mark->mask)
592 fsnotify_recalc_mask(mark->connector);
Eric Paris5444e292009-12-17 21:24:27 -0500593
594 return ret;
595err:
Jan Kara9cf90ce2017-10-31 10:09:25 +0100596 spin_lock(&mark->lock);
Jan Kara11375142016-11-09 14:54:20 +0100597 mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
598 FSNOTIFY_MARK_FLAG_ATTACHED);
Eric Paris5444e292009-12-17 21:24:27 -0500599 list_del_init(&mark->g_list);
Jan Kara9cf90ce2017-10-31 10:09:25 +0100600 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500601 atomic_dec(&group->num_marks);
Eric Paris5444e292009-12-17 21:24:27 -0500602
Jan Kara11375142016-11-09 14:54:20 +0100603 fsnotify_put_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500604 return ret;
605}
606
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300607int fsnotify_add_mark(struct fsnotify_mark *mark, fsnotify_connp_t *connp,
608 unsigned int type, int allow_dups)
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200609{
610 int ret;
Jan Kara7b1293232016-12-21 18:32:48 +0100611 struct fsnotify_group *group = mark->group;
612
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200613 mutex_lock(&group->mark_mutex);
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300614 ret = fsnotify_add_mark_locked(mark, connp, type, allow_dups);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200615 mutex_unlock(&group->mark_mutex);
616 return ret;
617}
618
Eric Paris5444e292009-12-17 21:24:27 -0500619/*
Jan Kara0809ab62014-12-12 16:58:36 -0800620 * Given a list of marks, find the mark associated with given group. If found
621 * take a reference to that mark and return it, else return NULL.
622 */
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300623struct fsnotify_mark *fsnotify_find_mark(fsnotify_connp_t *connp,
624 struct fsnotify_group *group)
Jan Kara0809ab62014-12-12 16:58:36 -0800625{
Jan Kara08991e82017-02-01 09:21:58 +0100626 struct fsnotify_mark_connector *conn;
Jan Kara0809ab62014-12-12 16:58:36 -0800627 struct fsnotify_mark *mark;
628
Jan Kara08991e82017-02-01 09:21:58 +0100629 conn = fsnotify_grab_connector(connp);
Jan Kara9dd813c2017-03-14 12:31:02 +0100630 if (!conn)
631 return NULL;
632
633 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara6b3f05d2016-12-21 12:15:30 +0100634 if (mark->group == group &&
635 (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Jan Kara0809ab62014-12-12 16:58:36 -0800636 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100637 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800638 return mark;
639 }
640 }
Jan Kara04662ca2017-02-01 08:19:43 +0100641 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800642 return NULL;
643}
644
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700645/* Clear any marks in a group with given type mask */
Jan Kara18f2e0d2017-01-04 10:33:18 +0100646void fsnotify_clear_marks_by_group(struct fsnotify_group *group,
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700647 unsigned int type_mask)
Eric Paris5444e292009-12-17 21:24:27 -0500648{
649 struct fsnotify_mark *lmark, *mark;
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700650 LIST_HEAD(to_free);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100651 struct list_head *head = &to_free;
Eric Paris5444e292009-12-17 21:24:27 -0500652
Jan Kara2e37c6c2017-01-04 10:51:58 +0100653 /* Skip selection step if we want to clear all marks. */
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700654 if (type_mask == FSNOTIFY_OBJ_ALL_TYPES_MASK) {
Jan Kara2e37c6c2017-01-04 10:51:58 +0100655 head = &group->marks_list;
656 goto clear;
657 }
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700658 /*
659 * We have to be really careful here. Anytime we drop mark_mutex, e.g.
660 * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
661 * to_free list so we have to use mark_mutex even when accessing that
662 * list. And freeing mark requires us to drop mark_mutex. So we can
663 * reliably free only the first mark in the list. That's why we first
664 * move marks to free to to_free list in one go and then free marks in
665 * to_free list one by one.
666 */
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200667 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Eric Paris5444e292009-12-17 21:24:27 -0500668 list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700669 if ((1U << mark->connector->type) & type_mask)
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700670 list_move(&mark->g_list, &to_free);
Eric Paris5444e292009-12-17 21:24:27 -0500671 }
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200672 mutex_unlock(&group->mark_mutex);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700673
Jan Kara2e37c6c2017-01-04 10:51:58 +0100674clear:
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700675 while (1) {
676 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100677 if (list_empty(head)) {
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700678 mutex_unlock(&group->mark_mutex);
679 break;
680 }
Jan Kara2e37c6c2017-01-04 10:51:58 +0100681 mark = list_first_entry(head, struct fsnotify_mark, g_list);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700682 fsnotify_get_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700683 fsnotify_detach_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700684 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700685 fsnotify_free_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700686 fsnotify_put_mark(mark);
687 }
Eric Paris5444e292009-12-17 21:24:27 -0500688}
689
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300690/* Destroy all marks attached to an object via connector */
691void fsnotify_destroy_marks(fsnotify_connp_t *connp)
Jan Kara0810b4f2017-02-01 09:23:48 +0100692{
Jan Kara08991e82017-02-01 09:21:58 +0100693 struct fsnotify_mark_connector *conn;
Jan Kara6b3f05d2016-12-21 12:15:30 +0100694 struct fsnotify_mark *mark, *old_mark = NULL;
695 struct inode *inode;
Jan Kara0810b4f2017-02-01 09:23:48 +0100696
Jan Kara6b3f05d2016-12-21 12:15:30 +0100697 conn = fsnotify_grab_connector(connp);
698 if (!conn)
699 return;
700 /*
701 * We have to be careful since we can race with e.g.
702 * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
703 * list can get modified. However we are holding mark reference and
704 * thus our mark cannot be removed from obj_list so we can continue
705 * iteration after regaining conn->lock.
706 */
707 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara0810b4f2017-02-01 09:23:48 +0100708 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100709 spin_unlock(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100710 if (old_mark)
711 fsnotify_put_mark(old_mark);
712 old_mark = mark;
Jan Kara0810b4f2017-02-01 09:23:48 +0100713 fsnotify_destroy_mark(mark, mark->group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100714 spin_lock(&conn->lock);
Jan Kara0810b4f2017-02-01 09:23:48 +0100715 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100716 /*
717 * Detach list from object now so that we don't pin inode until all
718 * mark references get dropped. It would lead to strange results such
719 * as delaying inode deletion or blocking unmount.
720 */
721 inode = fsnotify_detach_connector_from_object(conn);
722 spin_unlock(&conn->lock);
723 if (old_mark)
724 fsnotify_put_mark(old_mark);
725 iput(inode);
Jan Kara0810b4f2017-02-01 09:23:48 +0100726}
727
Eric Paris5444e292009-12-17 21:24:27 -0500728/*
729 * Nothing fancy, just initialize lists and locks and counters.
730 */
731void fsnotify_init_mark(struct fsnotify_mark *mark,
Jan Kara054c6362016-12-21 18:06:12 +0100732 struct fsnotify_group *group)
Eric Paris5444e292009-12-17 21:24:27 -0500733{
Eric Parisba643f02009-12-17 21:24:27 -0500734 memset(mark, 0, sizeof(*mark));
Eric Paris5444e292009-12-17 21:24:27 -0500735 spin_lock_init(&mark->lock);
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300736 refcount_set(&mark->refcnt, 1);
Jan Kara7b1293232016-12-21 18:32:48 +0100737 fsnotify_get_group(group);
738 mark->group = group;
Eric Paris5444e292009-12-17 21:24:27 -0500739}
Jeff Layton13d34ac2016-02-17 13:11:18 -0800740
Jan Kara35e48172016-05-19 17:08:59 -0700741/*
742 * Destroy all marks in destroy_list, waits for SRCU period to finish before
743 * actually freeing marks.
744 */
Jan Karaf09b04a2016-12-21 14:48:18 +0100745static void fsnotify_mark_destroy_workfn(struct work_struct *work)
Jeff Layton13d34ac2016-02-17 13:11:18 -0800746{
747 struct fsnotify_mark *mark, *next;
748 struct list_head private_destroy_list;
749
Jeff Layton0918f1c2016-02-17 13:11:21 -0800750 spin_lock(&destroy_lock);
751 /* exchange the list head */
752 list_replace_init(&destroy_list, &private_destroy_list);
753 spin_unlock(&destroy_lock);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800754
Jeff Layton0918f1c2016-02-17 13:11:21 -0800755 synchronize_srcu(&fsnotify_mark_srcu);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800756
Jeff Layton0918f1c2016-02-17 13:11:21 -0800757 list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
758 list_del_init(&mark->g_list);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100759 fsnotify_final_mark_destroy(mark);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800760 }
Jeff Layton13d34ac2016-02-17 13:11:18 -0800761}
Jan Kara35e48172016-05-19 17:08:59 -0700762
Jan Karaf09b04a2016-12-21 14:48:18 +0100763/* Wait for all marks queued for destruction to be actually destroyed */
764void fsnotify_wait_marks_destroyed(void)
Jan Kara35e48172016-05-19 17:08:59 -0700765{
Jan Karaf09b04a2016-12-21 14:48:18 +0100766 flush_delayed_work(&reaper_work);
Jan Kara35e48172016-05-19 17:08:59 -0700767}