blob: 05506d60131c69d546f574e9633f7d01039c70c6 [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
Amir Goldstein3ac70bf2018-06-23 17:54:50 +0300112static __u32 *fsnotify_conn_mask_p(struct fsnotify_mark_connector *conn)
113{
114 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
115 return &fsnotify_conn_inode(conn)->i_fsnotify_mask;
116 else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT)
117 return &fsnotify_conn_mount(conn)->mnt_fsnotify_mask;
118 return NULL;
119}
120
121__u32 fsnotify_conn_mask(struct fsnotify_mark_connector *conn)
122{
123 if (WARN_ON(!fsnotify_valid_obj_type(conn->type)))
124 return 0;
125
126 return *fsnotify_conn_mask_p(conn);
127}
128
Jan Karaa2426772017-03-15 09:16:27 +0100129static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
Jan Kara0809ab62014-12-12 16:58:36 -0800130{
131 u32 new_mask = 0;
132 struct fsnotify_mark *mark;
133
Jan Kara04662ca2017-02-01 08:19:43 +0100134 assert_spin_locked(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100135 hlist_for_each_entry(mark, &conn->list, obj_list) {
136 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)
137 new_mask |= mark->mask;
138 }
Amir Goldstein3ac70bf2018-06-23 17:54:50 +0300139 if (WARN_ON(!fsnotify_valid_obj_type(conn->type)))
140 return;
141
142 *fsnotify_conn_mask_p(conn) = new_mask;
Jan Karaa2426772017-03-15 09:16:27 +0100143}
144
145/*
146 * Calculate mask of events for a list of marks. The caller must make sure
Amir Goldstein36f10f52018-06-23 17:54:49 +0300147 * connector and connector->obj cannot disappear under us. Callers achieve
Jan Kara6b3f05d2016-12-21 12:15:30 +0100148 * this by holding a mark->lock or mark->group->mark_mutex for a mark on this
149 * list.
Jan Karaa2426772017-03-15 09:16:27 +0100150 */
151void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
152{
153 if (!conn)
154 return;
155
Jan Kara04662ca2017-02-01 08:19:43 +0100156 spin_lock(&conn->lock);
Jan Karaa2426772017-03-15 09:16:27 +0100157 __fsnotify_recalc_mask(conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100158 spin_unlock(&conn->lock);
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700159 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
Amir Goldstein36f10f52018-06-23 17:54:49 +0300160 __fsnotify_update_child_dentry_flags(
161 fsnotify_conn_inode(conn));
Jan Kara0809ab62014-12-12 16:58:36 -0800162}
163
Jan Kara08991e82017-02-01 09:21:58 +0100164/* Free all connectors queued for freeing once SRCU period ends */
165static void fsnotify_connector_destroy_workfn(struct work_struct *work)
166{
167 struct fsnotify_mark_connector *conn, *free;
168
169 spin_lock(&destroy_lock);
170 conn = connector_destroy_list;
171 connector_destroy_list = NULL;
172 spin_unlock(&destroy_lock);
173
174 synchronize_srcu(&fsnotify_mark_srcu);
175 while (conn) {
176 free = conn;
177 conn = conn->destroy_next;
178 kmem_cache_free(fsnotify_mark_connector_cachep, free);
179 }
180}
181
Jan Kara08991e82017-02-01 09:21:58 +0100182static struct inode *fsnotify_detach_connector_from_object(
183 struct fsnotify_mark_connector *conn)
184{
185 struct inode *inode = NULL;
186
Amir Goldstein36f10f52018-06-23 17:54:49 +0300187 if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED)
188 return NULL;
189
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700190 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE) {
Amir Goldstein36f10f52018-06-23 17:54:49 +0300191 inode = fsnotify_conn_inode(conn);
Jan Kara08991e82017-02-01 09:21:58 +0100192 inode->i_fsnotify_mask = 0;
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700193 } else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
Amir Goldstein36f10f52018-06-23 17:54:49 +0300194 fsnotify_conn_mount(conn)->mnt_fsnotify_mask = 0;
Jan Kara08991e82017-02-01 09:21:58 +0100195 }
196
Amir Goldstein36f10f52018-06-23 17:54:49 +0300197 rcu_assign_pointer(*(conn->obj), NULL);
198 conn->obj = NULL;
199 conn->type = FSNOTIFY_OBJ_TYPE_DETACHED;
200
Jan Kara08991e82017-02-01 09:21:58 +0100201 return inode;
202}
203
Jan Kara6b3f05d2016-12-21 12:15:30 +0100204static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
205{
Jan Kara054c6362016-12-21 18:06:12 +0100206 struct fsnotify_group *group = mark->group;
207
208 if (WARN_ON_ONCE(!group))
209 return;
210 group->ops->free_mark(mark);
211 fsnotify_put_group(group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100212}
213
214void fsnotify_put_mark(struct fsnotify_mark *mark)
Jan Kara8212a602017-03-15 09:48:11 +0100215{
216 struct fsnotify_mark_connector *conn;
217 struct inode *inode = NULL;
Jan Kara08991e82017-02-01 09:21:58 +0100218 bool free_conn = false;
Jan Kara8212a602017-03-15 09:48:11 +0100219
Jan Kara6b3f05d2016-12-21 12:15:30 +0100220 /* Catch marks that were actually never attached to object */
221 if (!mark->connector) {
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300222 if (refcount_dec_and_test(&mark->refcnt))
Jan Kara6b3f05d2016-12-21 12:15:30 +0100223 fsnotify_final_mark_destroy(mark);
224 return;
225 }
226
227 /*
228 * We have to be careful so that traversals of obj_list under lock can
229 * safely grab mark reference.
230 */
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300231 if (!refcount_dec_and_lock(&mark->refcnt, &mark->connector->lock))
Jan Kara6b3f05d2016-12-21 12:15:30 +0100232 return;
233
Jan Kara8212a602017-03-15 09:48:11 +0100234 conn = mark->connector;
Jan Kara8212a602017-03-15 09:48:11 +0100235 hlist_del_init_rcu(&mark->obj_list);
236 if (hlist_empty(&conn->list)) {
Jan Kara08991e82017-02-01 09:21:58 +0100237 inode = fsnotify_detach_connector_from_object(conn);
238 free_conn = true;
239 } else {
240 __fsnotify_recalc_mask(conn);
Jan Kara8212a602017-03-15 09:48:11 +0100241 }
242 mark->connector = NULL;
Jan Kara04662ca2017-02-01 08:19:43 +0100243 spin_unlock(&conn->lock);
Jan Kara8212a602017-03-15 09:48:11 +0100244
Jan Kara6b3f05d2016-12-21 12:15:30 +0100245 iput(inode);
246
Jan Kara08991e82017-02-01 09:21:58 +0100247 if (free_conn) {
248 spin_lock(&destroy_lock);
249 conn->destroy_next = connector_destroy_list;
250 connector_destroy_list = conn;
251 spin_unlock(&destroy_lock);
252 queue_work(system_unbound_wq, &connector_reaper_work);
253 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100254 /*
255 * Note that we didn't update flags telling whether inode cares about
256 * what's happening with children. We update these flags from
257 * __fsnotify_parent() lazily when next event happens on one of our
258 * children.
259 */
260 spin_lock(&destroy_lock);
261 list_add(&mark->g_list, &destroy_list);
262 spin_unlock(&destroy_lock);
263 queue_delayed_work(system_unbound_wq, &reaper_work,
264 FSNOTIFY_REAPER_DELAY);
Jan Kara8212a602017-03-15 09:48:11 +0100265}
266
Miklos Szeredi24c20302017-10-30 21:14:55 +0100267/*
268 * Get mark reference when we found the mark via lockless traversal of object
269 * list. Mark can be already removed from the list by now and on its way to be
270 * destroyed once SRCU period ends.
271 *
272 * Also pin the group so it doesn't disappear under us.
273 */
274static bool fsnotify_get_mark_safe(struct fsnotify_mark *mark)
Jan Karaabc77572016-11-10 16:02:11 +0100275{
Miklos Szeredi24c20302017-10-30 21:14:55 +0100276 if (!mark)
277 return true;
Jan Karaabc77572016-11-10 16:02:11 +0100278
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300279 if (refcount_inc_not_zero(&mark->refcnt)) {
Miklos Szeredi9a31d7a2017-10-30 21:14:56 +0100280 spin_lock(&mark->lock);
281 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) {
282 /* mark is attached, group is still alive then */
283 atomic_inc(&mark->group->user_waits);
284 spin_unlock(&mark->lock);
285 return true;
286 }
287 spin_unlock(&mark->lock);
288 fsnotify_put_mark(mark);
289 }
Miklos Szeredi24c20302017-10-30 21:14:55 +0100290 return false;
291}
292
293/*
294 * Puts marks and wakes up group destruction if necessary.
295 *
296 * Pairs with fsnotify_get_mark_safe()
297 */
298static void fsnotify_put_mark_wake(struct fsnotify_mark *mark)
299{
300 if (mark) {
301 struct fsnotify_group *group = mark->group;
302
303 fsnotify_put_mark(mark);
304 /*
305 * We abuse notification_waitq on group shutdown for waiting for
306 * all marks pinned when waiting for userspace.
307 */
308 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
309 wake_up(&group->notification_waitq);
Jan Karaabc77572016-11-10 16:02:11 +0100310 }
Miklos Szeredi24c20302017-10-30 21:14:55 +0100311}
312
313bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
314{
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700315 int type;
316
317 fsnotify_foreach_obj_type(type) {
318 /* This can fail if mark is being removed */
319 if (!fsnotify_get_mark_safe(iter_info->marks[type]))
320 goto fail;
Jan Karaabc77572016-11-10 16:02:11 +0100321 }
322
323 /*
324 * Now that both marks are pinned by refcount in the inode / vfsmount
325 * lists, we can drop SRCU lock, and safely resume the list iteration
326 * once userspace returns.
327 */
328 srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
329
330 return true;
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700331
332fail:
333 for (type--; type >= 0; type--)
334 fsnotify_put_mark_wake(iter_info->marks[type]);
335 return false;
Jan Karaabc77572016-11-10 16:02:11 +0100336}
337
338void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
339{
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700340 int type;
341
Jan Karaabc77572016-11-10 16:02:11 +0100342 iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
Amir Goldstein47d9c7c2018-04-20 16:10:52 -0700343 fsnotify_foreach_obj_type(type)
344 fsnotify_put_mark_wake(iter_info->marks[type]);
Jan Karaabc77572016-11-10 16:02:11 +0100345}
346
Eric Paris5444e292009-12-17 21:24:27 -0500347/*
Jan Kara6b3f05d2016-12-21 12:15:30 +0100348 * Mark mark as detached, remove it from group list. Mark still stays in object
349 * list until its last reference is dropped. Note that we rely on mark being
350 * removed from group list before corresponding reference to it is dropped. In
351 * particular we rely on mark->connector being valid while we hold
352 * group->mark_mutex if we found the mark through g_list.
Jan Kara4712e7222015-09-04 15:43:12 -0700353 *
Jan Kara11375142016-11-09 14:54:20 +0100354 * Must be called with group->mark_mutex held. The caller must either hold
355 * reference to the mark or be protected by fsnotify_mark_srcu.
Eric Paris5444e292009-12-17 21:24:27 -0500356 */
Jan Kara4712e7222015-09-04 15:43:12 -0700357void fsnotify_detach_mark(struct fsnotify_mark *mark)
Eric Paris5444e292009-12-17 21:24:27 -0500358{
Jan Kara4712e7222015-09-04 15:43:12 -0700359 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500360
Jan Kara11375142016-11-09 14:54:20 +0100361 WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
362 WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300363 refcount_read(&mark->refcnt) < 1 +
Jan Kara11375142016-11-09 14:54:20 +0100364 !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200365
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200366 spin_lock(&mark->lock);
Eric Paris700307a2010-07-28 10:18:38 -0400367 /* something else already called this function on this mark */
Jan Kara4712e7222015-09-04 15:43:12 -0700368 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Eric Paris5444e292009-12-17 21:24:27 -0500369 spin_unlock(&mark->lock);
Lino Sanfilippoe2a29942011-06-14 17:29:51 +0200370 return;
Eric Paris5444e292009-12-17 21:24:27 -0500371 }
Jan Kara4712e7222015-09-04 15:43:12 -0700372 mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris5444e292009-12-17 21:24:27 -0500373 list_del_init(&mark->g_list);
Eric Paris5444e292009-12-17 21:24:27 -0500374 spin_unlock(&mark->lock);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200375
Jan Kara4712e7222015-09-04 15:43:12 -0700376 atomic_dec(&group->num_marks);
Jan Kara11375142016-11-09 14:54:20 +0100377
378 /* Drop mark reference acquired in fsnotify_add_mark_locked() */
379 fsnotify_put_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700380}
381
382/*
Jan Kara11375142016-11-09 14:54:20 +0100383 * Free fsnotify mark. The mark is actually only marked as being freed. The
384 * freeing is actually happening only once last reference to the mark is
385 * dropped from a workqueue which first waits for srcu period end.
Jan Kara35e48172016-05-19 17:08:59 -0700386 *
Jan Kara11375142016-11-09 14:54:20 +0100387 * Caller must have a reference to the mark or be protected by
388 * fsnotify_mark_srcu.
Jan Kara4712e7222015-09-04 15:43:12 -0700389 */
Jan Kara11375142016-11-09 14:54:20 +0100390void fsnotify_free_mark(struct fsnotify_mark *mark)
Jan Kara4712e7222015-09-04 15:43:12 -0700391{
392 struct fsnotify_group *group = mark->group;
393
394 spin_lock(&mark->lock);
395 /* something else already called this function on this mark */
396 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
397 spin_unlock(&mark->lock);
Jan Kara11375142016-11-09 14:54:20 +0100398 return;
Jan Kara4712e7222015-09-04 15:43:12 -0700399 }
400 mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
401 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500402
Linus Torvaldsd725e662015-07-21 16:06:53 -0700403 /*
404 * Some groups like to know that marks are being freed. This is a
405 * callback to the group function to let it know that this mark
406 * is being freed.
407 */
408 if (group->ops->freeing_mark)
409 group->ops->freeing_mark(mark, group);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200410}
411
412void fsnotify_destroy_mark(struct fsnotify_mark *mark,
413 struct fsnotify_group *group)
414{
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200415 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara4712e7222015-09-04 15:43:12 -0700416 fsnotify_detach_mark(mark);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200417 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700418 fsnotify_free_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500419}
420
421/*
Jan Kara8edc6e12014-11-13 15:19:33 -0800422 * Sorting function for lists of fsnotify marks.
423 *
424 * Fanotify supports different notification classes (reflected as priority of
425 * notification group). Events shall be passed to notification groups in
426 * decreasing priority order. To achieve this marks in notification lists for
427 * inodes and vfsmounts are sorted so that priorities of corresponding groups
428 * are descending.
429 *
430 * Furthermore correct handling of the ignore mask requires processing inode
431 * and vfsmount marks of each group together. Using the group address as
432 * further sort criterion provides a unique sorting order and thus we can
433 * merge inode and vfsmount lists of marks in linear time and find groups
434 * present in both lists.
435 *
436 * A return value of 1 signifies that b has priority over a.
437 * A return value of 0 signifies that the two marks have to be handled together.
438 * A return value of -1 signifies that a has priority over b.
439 */
440int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
441{
442 if (a == b)
443 return 0;
444 if (!a)
445 return 1;
446 if (!b)
447 return -1;
448 if (a->priority < b->priority)
449 return 1;
450 if (a->priority > b->priority)
451 return -1;
452 if (a < b)
453 return 1;
454 return -1;
455}
456
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300457static int fsnotify_attach_connector_to_object(fsnotify_connp_t *connp,
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300458 unsigned int type)
Jan Kara9dd813c2017-03-14 12:31:02 +0100459{
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300460 struct inode *inode = NULL;
Jan Kara9dd813c2017-03-14 12:31:02 +0100461 struct fsnotify_mark_connector *conn;
462
Jan Kara755b5bc2017-03-14 16:11:23 +0100463 conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
Jan Kara9dd813c2017-03-14 12:31:02 +0100464 if (!conn)
465 return -ENOMEM;
Jan Kara04662ca2017-02-01 08:19:43 +0100466 spin_lock_init(&conn->lock);
Jan Kara9dd813c2017-03-14 12:31:02 +0100467 INIT_HLIST_HEAD(&conn->list);
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300468 conn->type = type;
Amir Goldstein36f10f52018-06-23 17:54:49 +0300469 conn->obj = connp;
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300470 if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
Amir Goldstein36f10f52018-06-23 17:54:49 +0300471 inode = igrab(fsnotify_conn_inode(conn));
Jan Kara9dd813c2017-03-14 12:31:02 +0100472 /*
Jan Kara04662ca2017-02-01 08:19:43 +0100473 * cmpxchg() provides the barrier so that readers of *connp can see
474 * only initialized structure
Jan Kara9dd813c2017-03-14 12:31:02 +0100475 */
Jan Kara04662ca2017-02-01 08:19:43 +0100476 if (cmpxchg(connp, NULL, conn)) {
477 /* Someone else created list structure for us */
Jan Kara08991e82017-02-01 09:21:58 +0100478 if (inode)
479 iput(inode);
Jan Kara755b5bc2017-03-14 16:11:23 +0100480 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100481 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100482
483 return 0;
484}
485
486/*
Jan Kara08991e82017-02-01 09:21:58 +0100487 * Get mark connector, make sure it is alive and return with its lock held.
488 * This is for users that get connector pointer from inode or mount. Users that
489 * hold reference to a mark on the list may directly lock connector->lock as
490 * they are sure list cannot go away under them.
491 */
492static struct fsnotify_mark_connector *fsnotify_grab_connector(
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300493 fsnotify_connp_t *connp)
Jan Kara08991e82017-02-01 09:21:58 +0100494{
495 struct fsnotify_mark_connector *conn;
496 int idx;
497
498 idx = srcu_read_lock(&fsnotify_mark_srcu);
499 conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
500 if (!conn)
501 goto out;
502 spin_lock(&conn->lock);
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700503 if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED) {
Jan Kara08991e82017-02-01 09:21:58 +0100504 spin_unlock(&conn->lock);
505 srcu_read_unlock(&fsnotify_mark_srcu, idx);
506 return NULL;
507 }
508out:
509 srcu_read_unlock(&fsnotify_mark_srcu, idx);
510 return conn;
511}
512
513/*
Jan Kara9dd813c2017-03-14 12:31:02 +0100514 * Add mark into proper place in given list of marks. These marks may be used
515 * for the fsnotify backend to determine which event types should be delivered
516 * to which group and for which inodes. These marks are ordered according to
517 * priority, highest number first, and then by the group's location in memory.
518 */
Jan Kara755b5bc2017-03-14 16:11:23 +0100519static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300520 fsnotify_connp_t *connp, unsigned int type,
Jan Kara755b5bc2017-03-14 16:11:23 +0100521 int allow_dups)
Jan Kara0809ab62014-12-12 16:58:36 -0800522{
523 struct fsnotify_mark *lmark, *last = NULL;
Jan Kara9dd813c2017-03-14 12:31:02 +0100524 struct fsnotify_mark_connector *conn;
Jan Kara0809ab62014-12-12 16:58:36 -0800525 int cmp;
Jan Kara755b5bc2017-03-14 16:11:23 +0100526 int err = 0;
527
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300528 if (WARN_ON(!fsnotify_valid_obj_type(type)))
Jan Kara755b5bc2017-03-14 16:11:23 +0100529 return -EINVAL;
Jan Kara08991e82017-02-01 09:21:58 +0100530restart:
531 spin_lock(&mark->lock);
532 conn = fsnotify_grab_connector(connp);
533 if (!conn) {
534 spin_unlock(&mark->lock);
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300535 err = fsnotify_attach_connector_to_object(connp, type);
Jan Kara9dd813c2017-03-14 12:31:02 +0100536 if (err)
537 return err;
Jan Kara08991e82017-02-01 09:21:58 +0100538 goto restart;
Jan Kara9dd813c2017-03-14 12:31:02 +0100539 }
Jan Kara0809ab62014-12-12 16:58:36 -0800540
541 /* is mark the first mark? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100542 if (hlist_empty(&conn->list)) {
543 hlist_add_head_rcu(&mark->obj_list, &conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100544 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800545 }
546
547 /* should mark be in the middle of the current list? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100548 hlist_for_each_entry(lmark, &conn->list, obj_list) {
Jan Kara0809ab62014-12-12 16:58:36 -0800549 last = lmark;
550
Jan Kara6b3f05d2016-12-21 12:15:30 +0100551 if ((lmark->group == mark->group) &&
552 (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
553 !allow_dups) {
Jan Kara755b5bc2017-03-14 16:11:23 +0100554 err = -EEXIST;
555 goto out_err;
556 }
Jan Kara0809ab62014-12-12 16:58:36 -0800557
558 cmp = fsnotify_compare_groups(lmark->group, mark->group);
559 if (cmp >= 0) {
560 hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100561 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800562 }
563 }
564
565 BUG_ON(last == NULL);
566 /* mark should be the last entry. last is the current last entry */
567 hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100568added:
569 mark->connector = conn;
Jan Kara755b5bc2017-03-14 16:11:23 +0100570out_err:
Jan Kara04662ca2017-02-01 08:19:43 +0100571 spin_unlock(&conn->lock);
Jan Kara755b5bc2017-03-14 16:11:23 +0100572 spin_unlock(&mark->lock);
573 return err;
Jan Kara0809ab62014-12-12 16:58:36 -0800574}
575
Jan Kara8edc6e12014-11-13 15:19:33 -0800576/*
Eric Paris5444e292009-12-17 21:24:27 -0500577 * Attach an initialized mark to a given group and fs object.
578 * These marks may be used for the fsnotify backend to determine which
579 * event types should be delivered to which group.
580 */
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300581int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
582 fsnotify_connp_t *connp, unsigned int type,
583 int allow_dups)
Eric Paris5444e292009-12-17 21:24:27 -0500584{
Jan Kara7b129322016-12-21 18:32:48 +0100585 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500586 int ret = 0;
587
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200588 BUG_ON(!mutex_is_locked(&group->mark_mutex));
Eric Paris5444e292009-12-17 21:24:27 -0500589
590 /*
Eric Paris5444e292009-12-17 21:24:27 -0500591 * LOCKING ORDER!!!!
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200592 * group->mark_mutex
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200593 * mark->lock
Jan Kara04662ca2017-02-01 08:19:43 +0100594 * mark->connector->lock
Eric Paris5444e292009-12-17 21:24:27 -0500595 */
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200596 spin_lock(&mark->lock);
Jan Kara4712e7222015-09-04 15:43:12 -0700597 mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris700307a2010-07-28 10:18:38 -0400598
Eric Paris5444e292009-12-17 21:24:27 -0500599 list_add(&mark->g_list, &group->marks_list);
600 atomic_inc(&group->num_marks);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100601 fsnotify_get_mark(mark); /* for g_list */
Eric Paris5444e292009-12-17 21:24:27 -0500602 spin_unlock(&mark->lock);
603
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300604 ret = fsnotify_add_mark_list(mark, connp, type, allow_dups);
Jan Kara755b5bc2017-03-14 16:11:23 +0100605 if (ret)
606 goto err;
607
Jan Karaa2426772017-03-15 09:16:27 +0100608 if (mark->mask)
609 fsnotify_recalc_mask(mark->connector);
Eric Paris5444e292009-12-17 21:24:27 -0500610
611 return ret;
612err:
Jan Kara9cf90ce2017-10-31 10:09:25 +0100613 spin_lock(&mark->lock);
Jan Kara11375142016-11-09 14:54:20 +0100614 mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
615 FSNOTIFY_MARK_FLAG_ATTACHED);
Eric Paris5444e292009-12-17 21:24:27 -0500616 list_del_init(&mark->g_list);
Jan Kara9cf90ce2017-10-31 10:09:25 +0100617 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500618 atomic_dec(&group->num_marks);
Eric Paris5444e292009-12-17 21:24:27 -0500619
Jan Kara11375142016-11-09 14:54:20 +0100620 fsnotify_put_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500621 return ret;
622}
623
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300624int fsnotify_add_mark(struct fsnotify_mark *mark, fsnotify_connp_t *connp,
625 unsigned int type, int allow_dups)
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200626{
627 int ret;
Jan Kara7b129322016-12-21 18:32:48 +0100628 struct fsnotify_group *group = mark->group;
629
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200630 mutex_lock(&group->mark_mutex);
Amir Goldsteinb812a9f2018-06-23 17:54:48 +0300631 ret = fsnotify_add_mark_locked(mark, connp, type, allow_dups);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200632 mutex_unlock(&group->mark_mutex);
633 return ret;
634}
635
Eric Paris5444e292009-12-17 21:24:27 -0500636/*
Jan Kara0809ab62014-12-12 16:58:36 -0800637 * Given a list of marks, find the mark associated with given group. If found
638 * take a reference to that mark and return it, else return NULL.
639 */
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300640struct fsnotify_mark *fsnotify_find_mark(fsnotify_connp_t *connp,
641 struct fsnotify_group *group)
Jan Kara0809ab62014-12-12 16:58:36 -0800642{
Jan Kara08991e82017-02-01 09:21:58 +0100643 struct fsnotify_mark_connector *conn;
Jan Kara0809ab62014-12-12 16:58:36 -0800644 struct fsnotify_mark *mark;
645
Jan Kara08991e82017-02-01 09:21:58 +0100646 conn = fsnotify_grab_connector(connp);
Jan Kara9dd813c2017-03-14 12:31:02 +0100647 if (!conn)
648 return NULL;
649
650 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara6b3f05d2016-12-21 12:15:30 +0100651 if (mark->group == group &&
652 (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Jan Kara0809ab62014-12-12 16:58:36 -0800653 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100654 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800655 return mark;
656 }
657 }
Jan Kara04662ca2017-02-01 08:19:43 +0100658 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800659 return NULL;
660}
661
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700662/* Clear any marks in a group with given type mask */
Jan Kara18f2e0d2017-01-04 10:33:18 +0100663void fsnotify_clear_marks_by_group(struct fsnotify_group *group,
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700664 unsigned int type_mask)
Eric Paris5444e292009-12-17 21:24:27 -0500665{
666 struct fsnotify_mark *lmark, *mark;
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700667 LIST_HEAD(to_free);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100668 struct list_head *head = &to_free;
Eric Paris5444e292009-12-17 21:24:27 -0500669
Jan Kara2e37c6c2017-01-04 10:51:58 +0100670 /* Skip selection step if we want to clear all marks. */
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700671 if (type_mask == FSNOTIFY_OBJ_ALL_TYPES_MASK) {
Jan Kara2e37c6c2017-01-04 10:51:58 +0100672 head = &group->marks_list;
673 goto clear;
674 }
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700675 /*
676 * We have to be really careful here. Anytime we drop mark_mutex, e.g.
677 * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
678 * to_free list so we have to use mark_mutex even when accessing that
679 * list. And freeing mark requires us to drop mark_mutex. So we can
680 * reliably free only the first mark in the list. That's why we first
681 * move marks to free to to_free list in one go and then free marks in
682 * to_free list one by one.
683 */
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200684 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Eric Paris5444e292009-12-17 21:24:27 -0500685 list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
Amir Goldsteind6f7b982018-04-20 16:10:49 -0700686 if ((1U << mark->connector->type) & type_mask)
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700687 list_move(&mark->g_list, &to_free);
Eric Paris5444e292009-12-17 21:24:27 -0500688 }
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200689 mutex_unlock(&group->mark_mutex);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700690
Jan Kara2e37c6c2017-01-04 10:51:58 +0100691clear:
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700692 while (1) {
693 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara2e37c6c2017-01-04 10:51:58 +0100694 if (list_empty(head)) {
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700695 mutex_unlock(&group->mark_mutex);
696 break;
697 }
Jan Kara2e37c6c2017-01-04 10:51:58 +0100698 mark = list_first_entry(head, struct fsnotify_mark, g_list);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700699 fsnotify_get_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700700 fsnotify_detach_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700701 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700702 fsnotify_free_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700703 fsnotify_put_mark(mark);
704 }
Eric Paris5444e292009-12-17 21:24:27 -0500705}
706
Amir Goldstein9b6e5432018-06-23 17:54:47 +0300707/* Destroy all marks attached to an object via connector */
708void fsnotify_destroy_marks(fsnotify_connp_t *connp)
Jan Kara0810b4f2017-02-01 09:23:48 +0100709{
Jan Kara08991e82017-02-01 09:21:58 +0100710 struct fsnotify_mark_connector *conn;
Jan Kara6b3f05d2016-12-21 12:15:30 +0100711 struct fsnotify_mark *mark, *old_mark = NULL;
712 struct inode *inode;
Jan Kara0810b4f2017-02-01 09:23:48 +0100713
Jan Kara6b3f05d2016-12-21 12:15:30 +0100714 conn = fsnotify_grab_connector(connp);
715 if (!conn)
716 return;
717 /*
718 * We have to be careful since we can race with e.g.
719 * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
720 * list can get modified. However we are holding mark reference and
721 * thus our mark cannot be removed from obj_list so we can continue
722 * iteration after regaining conn->lock.
723 */
724 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara0810b4f2017-02-01 09:23:48 +0100725 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100726 spin_unlock(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100727 if (old_mark)
728 fsnotify_put_mark(old_mark);
729 old_mark = mark;
Jan Kara0810b4f2017-02-01 09:23:48 +0100730 fsnotify_destroy_mark(mark, mark->group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100731 spin_lock(&conn->lock);
Jan Kara0810b4f2017-02-01 09:23:48 +0100732 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100733 /*
734 * Detach list from object now so that we don't pin inode until all
735 * mark references get dropped. It would lead to strange results such
736 * as delaying inode deletion or blocking unmount.
737 */
738 inode = fsnotify_detach_connector_from_object(conn);
739 spin_unlock(&conn->lock);
740 if (old_mark)
741 fsnotify_put_mark(old_mark);
742 iput(inode);
Jan Kara0810b4f2017-02-01 09:23:48 +0100743}
744
Eric Paris5444e292009-12-17 21:24:27 -0500745/*
746 * Nothing fancy, just initialize lists and locks and counters.
747 */
748void fsnotify_init_mark(struct fsnotify_mark *mark,
Jan Kara054c6362016-12-21 18:06:12 +0100749 struct fsnotify_group *group)
Eric Paris5444e292009-12-17 21:24:27 -0500750{
Eric Parisba643f02009-12-17 21:24:27 -0500751 memset(mark, 0, sizeof(*mark));
Eric Paris5444e292009-12-17 21:24:27 -0500752 spin_lock_init(&mark->lock);
Elena Reshetovaab97f8732017-10-20 13:26:02 +0300753 refcount_set(&mark->refcnt, 1);
Jan Kara7b129322016-12-21 18:32:48 +0100754 fsnotify_get_group(group);
755 mark->group = group;
Eric Paris5444e292009-12-17 21:24:27 -0500756}
Jeff Layton13d34ac2016-02-17 13:11:18 -0800757
Jan Kara35e48172016-05-19 17:08:59 -0700758/*
759 * Destroy all marks in destroy_list, waits for SRCU period to finish before
760 * actually freeing marks.
761 */
Jan Karaf09b04a2016-12-21 14:48:18 +0100762static void fsnotify_mark_destroy_workfn(struct work_struct *work)
Jeff Layton13d34ac2016-02-17 13:11:18 -0800763{
764 struct fsnotify_mark *mark, *next;
765 struct list_head private_destroy_list;
766
Jeff Layton0918f1c2016-02-17 13:11:21 -0800767 spin_lock(&destroy_lock);
768 /* exchange the list head */
769 list_replace_init(&destroy_list, &private_destroy_list);
770 spin_unlock(&destroy_lock);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800771
Jeff Layton0918f1c2016-02-17 13:11:21 -0800772 synchronize_srcu(&fsnotify_mark_srcu);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800773
Jeff Layton0918f1c2016-02-17 13:11:21 -0800774 list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
775 list_del_init(&mark->g_list);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100776 fsnotify_final_mark_destroy(mark);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800777 }
Jeff Layton13d34ac2016-02-17 13:11:18 -0800778}
Jan Kara35e48172016-05-19 17:08:59 -0700779
Jan Karaf09b04a2016-12-21 14:48:18 +0100780/* Wait for all marks queued for destruction to be actually destroyed */
781void fsnotify_wait_marks_destroyed(void)
Jan Kara35e48172016-05-19 17:08:59 -0700782{
Jan Karaf09b04a2016-12-21 14:48:18 +0100783 flush_delayed_work(&reaper_work);
Jan Kara35e48172016-05-19 17:08:59 -0700784}