blob: f916b71c9139face6e806545b1d977c68f16f2a3 [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
70 * need to be cleaned up. (fsnotify_clear_marks_by_group)
71 *
Eric Paris5444e292009-12-17 21:24:27 -050072 * This has the very interesting property of being able to run concurrently with
73 * any (or all) other directions.
74 */
75
76#include <linux/fs.h>
77#include <linux/init.h>
78#include <linux/kernel.h>
Eric Paris75c1be42010-07-28 10:18:38 -040079#include <linux/kthread.h>
Eric Paris5444e292009-12-17 21:24:27 -050080#include <linux/module.h>
81#include <linux/mutex.h>
82#include <linux/slab.h>
83#include <linux/spinlock.h>
Eric Paris75c1be42010-07-28 10:18:38 -040084#include <linux/srcu.h>
Eric Paris5444e292009-12-17 21:24:27 -050085
Arun Sharma600634972011-07-26 16:09:06 -070086#include <linux/atomic.h>
Eric Paris5444e292009-12-17 21:24:27 -050087
88#include <linux/fsnotify_backend.h>
89#include "fsnotify.h"
90
Jeff Layton0918f1c2016-02-17 13:11:21 -080091#define FSNOTIFY_REAPER_DELAY (1) /* 1 jiffy */
92
Eric Paris75c1be42010-07-28 10:18:38 -040093struct srcu_struct fsnotify_mark_srcu;
Jan Kara9dd813c2017-03-14 12:31:02 +010094struct kmem_cache *fsnotify_mark_connector_cachep;
95
Jeff Layton13d34ac2016-02-17 13:11:18 -080096static DEFINE_SPINLOCK(destroy_lock);
97static LIST_HEAD(destroy_list);
Jan Kara08991e82017-02-01 09:21:58 +010098static struct fsnotify_mark_connector *connector_destroy_list;
Jeff Layton0918f1c2016-02-17 13:11:21 -080099
Jan Kara35e48172016-05-19 17:08:59 -0700100static void fsnotify_mark_destroy_workfn(struct work_struct *work);
101static DECLARE_DELAYED_WORK(reaper_work, fsnotify_mark_destroy_workfn);
Eric Paris75c1be42010-07-28 10:18:38 -0400102
Jan Kara08991e82017-02-01 09:21:58 +0100103static void fsnotify_connector_destroy_workfn(struct work_struct *work);
104static DECLARE_WORK(connector_reaper_work, fsnotify_connector_destroy_workfn);
105
Eric Paris5444e292009-12-17 21:24:27 -0500106void fsnotify_get_mark(struct fsnotify_mark *mark)
107{
Jan Kara11375142016-11-09 14:54:20 +0100108 WARN_ON_ONCE(!atomic_read(&mark->refcnt));
Eric Paris5444e292009-12-17 21:24:27 -0500109 atomic_inc(&mark->refcnt);
110}
111
Jan 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 }
Jan Karaa2426772017-03-15 09:16:27 +0100122 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE)
123 conn->inode->i_fsnotify_mask = new_mask;
124 else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT)
125 real_mount(conn->mnt)->mnt_fsnotify_mask = new_mask;
126}
127
128/*
129 * Calculate mask of events for a list of marks. The caller must make sure
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);
142 if (conn->flags & 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
169 if (conn->flags & FSNOTIFY_OBJ_TYPE_INODE) {
170 inode = conn->inode;
171 rcu_assign_pointer(inode->i_fsnotify_marks, NULL);
172 inode->i_fsnotify_mask = 0;
173 conn->inode = NULL;
174 conn->flags &= ~FSNOTIFY_OBJ_TYPE_INODE;
175 } else if (conn->flags & FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
176 rcu_assign_pointer(real_mount(conn->mnt)->mnt_fsnotify_marks,
177 NULL);
178 real_mount(conn->mnt)->mnt_fsnotify_mask = 0;
179 conn->mnt = NULL;
180 conn->flags &= ~FSNOTIFY_OBJ_TYPE_VFSMOUNT;
181 }
182
183 return inode;
184}
185
Jan Kara6b3f05d2016-12-21 12:15:30 +0100186static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
187{
188 if (mark->group)
189 fsnotify_put_group(mark->group);
190 mark->free_mark(mark);
191}
192
193void fsnotify_put_mark(struct fsnotify_mark *mark)
Jan Kara8212a602017-03-15 09:48:11 +0100194{
195 struct fsnotify_mark_connector *conn;
196 struct inode *inode = NULL;
Jan Kara08991e82017-02-01 09:21:58 +0100197 bool free_conn = false;
Jan Kara8212a602017-03-15 09:48:11 +0100198
Jan Kara6b3f05d2016-12-21 12:15:30 +0100199 /* Catch marks that were actually never attached to object */
200 if (!mark->connector) {
201 if (atomic_dec_and_test(&mark->refcnt))
202 fsnotify_final_mark_destroy(mark);
203 return;
204 }
205
206 /*
207 * We have to be careful so that traversals of obj_list under lock can
208 * safely grab mark reference.
209 */
210 if (!atomic_dec_and_lock(&mark->refcnt, &mark->connector->lock))
211 return;
212
Jan Kara8212a602017-03-15 09:48:11 +0100213 conn = mark->connector;
Jan Kara8212a602017-03-15 09:48:11 +0100214 hlist_del_init_rcu(&mark->obj_list);
215 if (hlist_empty(&conn->list)) {
Jan Kara08991e82017-02-01 09:21:58 +0100216 inode = fsnotify_detach_connector_from_object(conn);
217 free_conn = true;
218 } else {
219 __fsnotify_recalc_mask(conn);
Jan Kara8212a602017-03-15 09:48:11 +0100220 }
221 mark->connector = NULL;
Jan Kara04662ca2017-02-01 08:19:43 +0100222 spin_unlock(&conn->lock);
Jan Kara8212a602017-03-15 09:48:11 +0100223
Jan Kara6b3f05d2016-12-21 12:15:30 +0100224 iput(inode);
225
Jan Kara08991e82017-02-01 09:21:58 +0100226 if (free_conn) {
227 spin_lock(&destroy_lock);
228 conn->destroy_next = connector_destroy_list;
229 connector_destroy_list = conn;
230 spin_unlock(&destroy_lock);
231 queue_work(system_unbound_wq, &connector_reaper_work);
232 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100233 /*
234 * Note that we didn't update flags telling whether inode cares about
235 * what's happening with children. We update these flags from
236 * __fsnotify_parent() lazily when next event happens on one of our
237 * children.
238 */
239 spin_lock(&destroy_lock);
240 list_add(&mark->g_list, &destroy_list);
241 spin_unlock(&destroy_lock);
242 queue_delayed_work(system_unbound_wq, &reaper_work,
243 FSNOTIFY_REAPER_DELAY);
Jan Kara8212a602017-03-15 09:48:11 +0100244}
245
Eric Paris5444e292009-12-17 21:24:27 -0500246/*
Jan Kara6b3f05d2016-12-21 12:15:30 +0100247 * Mark mark as detached, remove it from group list. Mark still stays in object
248 * list until its last reference is dropped. Note that we rely on mark being
249 * removed from group list before corresponding reference to it is dropped. In
250 * particular we rely on mark->connector being valid while we hold
251 * group->mark_mutex if we found the mark through g_list.
Jan Kara4712e7222015-09-04 15:43:12 -0700252 *
Jan Kara11375142016-11-09 14:54:20 +0100253 * Must be called with group->mark_mutex held. The caller must either hold
254 * reference to the mark or be protected by fsnotify_mark_srcu.
Eric Paris5444e292009-12-17 21:24:27 -0500255 */
Jan Kara4712e7222015-09-04 15:43:12 -0700256void fsnotify_detach_mark(struct fsnotify_mark *mark)
Eric Paris5444e292009-12-17 21:24:27 -0500257{
Jan Kara4712e7222015-09-04 15:43:12 -0700258 struct fsnotify_group *group = mark->group;
Eric Paris5444e292009-12-17 21:24:27 -0500259
Jan Kara11375142016-11-09 14:54:20 +0100260 WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
261 WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
262 atomic_read(&mark->refcnt) < 1 +
263 !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200264
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200265 spin_lock(&mark->lock);
Eric Paris700307a2010-07-28 10:18:38 -0400266 /* something else already called this function on this mark */
Jan Kara4712e7222015-09-04 15:43:12 -0700267 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Eric Paris5444e292009-12-17 21:24:27 -0500268 spin_unlock(&mark->lock);
Lino Sanfilippoe2a29942011-06-14 17:29:51 +0200269 return;
Eric Paris5444e292009-12-17 21:24:27 -0500270 }
Jan Kara4712e7222015-09-04 15:43:12 -0700271 mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris5444e292009-12-17 21:24:27 -0500272 list_del_init(&mark->g_list);
Eric Paris5444e292009-12-17 21:24:27 -0500273 spin_unlock(&mark->lock);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200274
Jan Kara4712e7222015-09-04 15:43:12 -0700275 atomic_dec(&group->num_marks);
Jan Kara11375142016-11-09 14:54:20 +0100276
277 /* Drop mark reference acquired in fsnotify_add_mark_locked() */
278 fsnotify_put_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700279}
280
281/*
Jan Kara11375142016-11-09 14:54:20 +0100282 * Free fsnotify mark. The mark is actually only marked as being freed. The
283 * freeing is actually happening only once last reference to the mark is
284 * dropped from a workqueue which first waits for srcu period end.
Jan Kara35e48172016-05-19 17:08:59 -0700285 *
Jan Kara11375142016-11-09 14:54:20 +0100286 * Caller must have a reference to the mark or be protected by
287 * fsnotify_mark_srcu.
Jan Kara4712e7222015-09-04 15:43:12 -0700288 */
Jan Kara11375142016-11-09 14:54:20 +0100289void fsnotify_free_mark(struct fsnotify_mark *mark)
Jan Kara4712e7222015-09-04 15:43:12 -0700290{
291 struct fsnotify_group *group = mark->group;
292
293 spin_lock(&mark->lock);
294 /* something else already called this function on this mark */
295 if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
296 spin_unlock(&mark->lock);
Jan Kara11375142016-11-09 14:54:20 +0100297 return;
Jan Kara4712e7222015-09-04 15:43:12 -0700298 }
299 mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
300 spin_unlock(&mark->lock);
Eric Paris5444e292009-12-17 21:24:27 -0500301
Linus Torvaldsd725e662015-07-21 16:06:53 -0700302 /*
303 * Some groups like to know that marks are being freed. This is a
304 * callback to the group function to let it know that this mark
305 * is being freed.
306 */
307 if (group->ops->freeing_mark)
308 group->ops->freeing_mark(mark, group);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200309}
310
311void fsnotify_destroy_mark(struct fsnotify_mark *mark,
312 struct fsnotify_group *group)
313{
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200314 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Jan Kara4712e7222015-09-04 15:43:12 -0700315 fsnotify_detach_mark(mark);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200316 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700317 fsnotify_free_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500318}
319
Eric Paris90b1e7a2009-12-17 21:24:33 -0500320void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask)
321{
322 assert_spin_locked(&mark->lock);
323
324 mark->mask = mask;
Eric Paris90b1e7a2009-12-17 21:24:33 -0500325}
326
Eric Paris33af5e32009-12-17 21:24:33 -0500327void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask)
328{
329 assert_spin_locked(&mark->lock);
330
331 mark->ignored_mask = mask;
332}
Eric Paris90b1e7a2009-12-17 21:24:33 -0500333
Eric Paris5444e292009-12-17 21:24:27 -0500334/*
Jan Kara8edc6e12014-11-13 15:19:33 -0800335 * Sorting function for lists of fsnotify marks.
336 *
337 * Fanotify supports different notification classes (reflected as priority of
338 * notification group). Events shall be passed to notification groups in
339 * decreasing priority order. To achieve this marks in notification lists for
340 * inodes and vfsmounts are sorted so that priorities of corresponding groups
341 * are descending.
342 *
343 * Furthermore correct handling of the ignore mask requires processing inode
344 * and vfsmount marks of each group together. Using the group address as
345 * further sort criterion provides a unique sorting order and thus we can
346 * merge inode and vfsmount lists of marks in linear time and find groups
347 * present in both lists.
348 *
349 * A return value of 1 signifies that b has priority over a.
350 * A return value of 0 signifies that the two marks have to be handled together.
351 * A return value of -1 signifies that a has priority over b.
352 */
353int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
354{
355 if (a == b)
356 return 0;
357 if (!a)
358 return 1;
359 if (!b)
360 return -1;
361 if (a->priority < b->priority)
362 return 1;
363 if (a->priority > b->priority)
364 return -1;
365 if (a < b)
366 return 1;
367 return -1;
368}
369
Jan Kara9dd813c2017-03-14 12:31:02 +0100370static int fsnotify_attach_connector_to_object(
Jan Kara08991e82017-02-01 09:21:58 +0100371 struct fsnotify_mark_connector __rcu **connp,
372 struct inode *inode,
373 struct vfsmount *mnt)
Jan Kara9dd813c2017-03-14 12:31:02 +0100374{
375 struct fsnotify_mark_connector *conn;
376
Jan Kara755b5bc2017-03-14 16:11:23 +0100377 conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
Jan Kara9dd813c2017-03-14 12:31:02 +0100378 if (!conn)
379 return -ENOMEM;
Jan Kara04662ca2017-02-01 08:19:43 +0100380 spin_lock_init(&conn->lock);
Jan Kara9dd813c2017-03-14 12:31:02 +0100381 INIT_HLIST_HEAD(&conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100382 if (inode) {
383 conn->flags = FSNOTIFY_OBJ_TYPE_INODE;
Jan Kara08991e82017-02-01 09:21:58 +0100384 conn->inode = igrab(inode);
Jan Kara86ffe242017-03-14 14:29:35 +0100385 } else {
386 conn->flags = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
387 conn->mnt = mnt;
388 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100389 /*
Jan Kara04662ca2017-02-01 08:19:43 +0100390 * cmpxchg() provides the barrier so that readers of *connp can see
391 * only initialized structure
Jan Kara9dd813c2017-03-14 12:31:02 +0100392 */
Jan Kara04662ca2017-02-01 08:19:43 +0100393 if (cmpxchg(connp, NULL, conn)) {
394 /* Someone else created list structure for us */
Jan Kara08991e82017-02-01 09:21:58 +0100395 if (inode)
396 iput(inode);
Jan Kara755b5bc2017-03-14 16:11:23 +0100397 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
Jan Kara04662ca2017-02-01 08:19:43 +0100398 }
Jan Kara9dd813c2017-03-14 12:31:02 +0100399
400 return 0;
401}
402
403/*
Jan Kara08991e82017-02-01 09:21:58 +0100404 * Get mark connector, make sure it is alive and return with its lock held.
405 * This is for users that get connector pointer from inode or mount. Users that
406 * hold reference to a mark on the list may directly lock connector->lock as
407 * they are sure list cannot go away under them.
408 */
409static struct fsnotify_mark_connector *fsnotify_grab_connector(
410 struct fsnotify_mark_connector __rcu **connp)
411{
412 struct fsnotify_mark_connector *conn;
413 int idx;
414
415 idx = srcu_read_lock(&fsnotify_mark_srcu);
416 conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
417 if (!conn)
418 goto out;
419 spin_lock(&conn->lock);
420 if (!(conn->flags & (FSNOTIFY_OBJ_TYPE_INODE |
421 FSNOTIFY_OBJ_TYPE_VFSMOUNT))) {
422 spin_unlock(&conn->lock);
423 srcu_read_unlock(&fsnotify_mark_srcu, idx);
424 return NULL;
425 }
426out:
427 srcu_read_unlock(&fsnotify_mark_srcu, idx);
428 return conn;
429}
430
431/*
Jan Kara9dd813c2017-03-14 12:31:02 +0100432 * Add mark into proper place in given list of marks. These marks may be used
433 * for the fsnotify backend to determine which event types should be delivered
434 * to which group and for which inodes. These marks are ordered according to
435 * priority, highest number first, and then by the group's location in memory.
436 */
Jan Kara755b5bc2017-03-14 16:11:23 +0100437static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
438 struct inode *inode, struct vfsmount *mnt,
439 int allow_dups)
Jan Kara0809ab62014-12-12 16:58:36 -0800440{
441 struct fsnotify_mark *lmark, *last = NULL;
Jan Kara9dd813c2017-03-14 12:31:02 +0100442 struct fsnotify_mark_connector *conn;
Jan Kara08991e82017-02-01 09:21:58 +0100443 struct fsnotify_mark_connector __rcu **connp;
Jan Kara0809ab62014-12-12 16:58:36 -0800444 int cmp;
Jan Kara755b5bc2017-03-14 16:11:23 +0100445 int err = 0;
446
447 if (WARN_ON(!inode && !mnt))
448 return -EINVAL;
Jan Kara04662ca2017-02-01 08:19:43 +0100449 if (inode)
Jan Kara755b5bc2017-03-14 16:11:23 +0100450 connp = &inode->i_fsnotify_marks;
Jan Kara04662ca2017-02-01 08:19:43 +0100451 else
Jan Kara755b5bc2017-03-14 16:11:23 +0100452 connp = &real_mount(mnt)->mnt_fsnotify_marks;
Jan Kara08991e82017-02-01 09:21:58 +0100453restart:
454 spin_lock(&mark->lock);
455 conn = fsnotify_grab_connector(connp);
456 if (!conn) {
457 spin_unlock(&mark->lock);
Jan Kara04662ca2017-02-01 08:19:43 +0100458 err = fsnotify_attach_connector_to_object(connp, inode, mnt);
Jan Kara9dd813c2017-03-14 12:31:02 +0100459 if (err)
460 return err;
Jan Kara08991e82017-02-01 09:21:58 +0100461 goto restart;
Jan Kara9dd813c2017-03-14 12:31:02 +0100462 }
Jan Kara0809ab62014-12-12 16:58:36 -0800463
464 /* is mark the first mark? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100465 if (hlist_empty(&conn->list)) {
466 hlist_add_head_rcu(&mark->obj_list, &conn->list);
Jan Kara86ffe242017-03-14 14:29:35 +0100467 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800468 }
469
470 /* should mark be in the middle of the current list? */
Jan Kara9dd813c2017-03-14 12:31:02 +0100471 hlist_for_each_entry(lmark, &conn->list, obj_list) {
Jan Kara0809ab62014-12-12 16:58:36 -0800472 last = lmark;
473
Jan Kara6b3f05d2016-12-21 12:15:30 +0100474 if ((lmark->group == mark->group) &&
475 (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
476 !allow_dups) {
Jan Kara755b5bc2017-03-14 16:11:23 +0100477 err = -EEXIST;
478 goto out_err;
479 }
Jan Kara0809ab62014-12-12 16:58:36 -0800480
481 cmp = fsnotify_compare_groups(lmark->group, mark->group);
482 if (cmp >= 0) {
483 hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100484 goto added;
Jan Kara0809ab62014-12-12 16:58:36 -0800485 }
486 }
487
488 BUG_ON(last == NULL);
489 /* mark should be the last entry. last is the current last entry */
490 hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
Jan Kara86ffe242017-03-14 14:29:35 +0100491added:
492 mark->connector = conn;
Jan Kara755b5bc2017-03-14 16:11:23 +0100493out_err:
Jan Kara04662ca2017-02-01 08:19:43 +0100494 spin_unlock(&conn->lock);
Jan Kara755b5bc2017-03-14 16:11:23 +0100495 spin_unlock(&mark->lock);
496 return err;
Jan Kara0809ab62014-12-12 16:58:36 -0800497}
498
Jan Kara8edc6e12014-11-13 15:19:33 -0800499/*
Eric Paris5444e292009-12-17 21:24:27 -0500500 * Attach an initialized mark to a given group and fs object.
501 * These marks may be used for the fsnotify backend to determine which
502 * event types should be delivered to which group.
503 */
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200504int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
505 struct fsnotify_group *group, struct inode *inode,
506 struct vfsmount *mnt, int allow_dups)
Eric Paris5444e292009-12-17 21:24:27 -0500507{
508 int ret = 0;
509
Eric Paris5444e292009-12-17 21:24:27 -0500510 BUG_ON(inode && mnt);
511 BUG_ON(!inode && !mnt);
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200512 BUG_ON(!mutex_is_locked(&group->mark_mutex));
Eric Paris5444e292009-12-17 21:24:27 -0500513
514 /*
Eric Paris5444e292009-12-17 21:24:27 -0500515 * LOCKING ORDER!!!!
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200516 * group->mark_mutex
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200517 * mark->lock
Jan Kara04662ca2017-02-01 08:19:43 +0100518 * mark->connector->lock
Eric Paris5444e292009-12-17 21:24:27 -0500519 */
Lino Sanfilippo104d06f2011-06-14 17:29:48 +0200520 spin_lock(&mark->lock);
Jan Kara4712e7222015-09-04 15:43:12 -0700521 mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
Eric Paris700307a2010-07-28 10:18:38 -0400522
Lino Sanfilippo23e964c2011-06-14 17:29:47 +0200523 fsnotify_get_group(group);
Eric Paris5444e292009-12-17 21:24:27 -0500524 mark->group = group;
525 list_add(&mark->g_list, &group->marks_list);
526 atomic_inc(&group->num_marks);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100527 fsnotify_get_mark(mark); /* for g_list */
Eric Paris5444e292009-12-17 21:24:27 -0500528 spin_unlock(&mark->lock);
529
Jan Kara755b5bc2017-03-14 16:11:23 +0100530 ret = fsnotify_add_mark_list(mark, inode, mnt, allow_dups);
531 if (ret)
532 goto err;
533
Jan Karaa2426772017-03-15 09:16:27 +0100534 if (mark->mask)
535 fsnotify_recalc_mask(mark->connector);
Eric Paris5444e292009-12-17 21:24:27 -0500536
537 return ret;
538err:
Jan Kara11375142016-11-09 14:54:20 +0100539 mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
540 FSNOTIFY_MARK_FLAG_ATTACHED);
Eric Paris5444e292009-12-17 21:24:27 -0500541 list_del_init(&mark->g_list);
542 atomic_dec(&group->num_marks);
Eric Paris5444e292009-12-17 21:24:27 -0500543 spin_unlock(&mark->lock);
544
Jan Kara11375142016-11-09 14:54:20 +0100545 fsnotify_put_mark(mark);
Eric Paris5444e292009-12-17 21:24:27 -0500546 return ret;
547}
548
Lino Sanfilippod5a335b2011-06-14 17:29:52 +0200549int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
550 struct inode *inode, struct vfsmount *mnt, int allow_dups)
551{
552 int ret;
553 mutex_lock(&group->mark_mutex);
554 ret = fsnotify_add_mark_locked(mark, group, inode, mnt, allow_dups);
555 mutex_unlock(&group->mark_mutex);
556 return ret;
557}
558
Eric Paris5444e292009-12-17 21:24:27 -0500559/*
Jan Kara0809ab62014-12-12 16:58:36 -0800560 * Given a list of marks, find the mark associated with given group. If found
561 * take a reference to that mark and return it, else return NULL.
562 */
Jan Kara08991e82017-02-01 09:21:58 +0100563struct fsnotify_mark *fsnotify_find_mark(
564 struct fsnotify_mark_connector __rcu **connp,
565 struct fsnotify_group *group)
Jan Kara0809ab62014-12-12 16:58:36 -0800566{
Jan Kara08991e82017-02-01 09:21:58 +0100567 struct fsnotify_mark_connector *conn;
Jan Kara0809ab62014-12-12 16:58:36 -0800568 struct fsnotify_mark *mark;
569
Jan Kara08991e82017-02-01 09:21:58 +0100570 conn = fsnotify_grab_connector(connp);
Jan Kara9dd813c2017-03-14 12:31:02 +0100571 if (!conn)
572 return NULL;
573
574 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara6b3f05d2016-12-21 12:15:30 +0100575 if (mark->group == group &&
576 (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
Jan Kara0809ab62014-12-12 16:58:36 -0800577 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100578 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800579 return mark;
580 }
581 }
Jan Kara04662ca2017-02-01 08:19:43 +0100582 spin_unlock(&conn->lock);
Jan Kara0809ab62014-12-12 16:58:36 -0800583 return NULL;
584}
585
586/*
Linus Torvaldsd725e662015-07-21 16:06:53 -0700587 * clear any marks in a group in which mark->flags & flags is true
Eric Paris5444e292009-12-17 21:24:27 -0500588 */
Eric Paris4d926042009-12-17 21:24:34 -0500589void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group,
590 unsigned int flags)
Eric Paris5444e292009-12-17 21:24:27 -0500591{
592 struct fsnotify_mark *lmark, *mark;
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700593 LIST_HEAD(to_free);
Eric Paris5444e292009-12-17 21:24:27 -0500594
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700595 /*
596 * We have to be really careful here. Anytime we drop mark_mutex, e.g.
597 * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
598 * to_free list so we have to use mark_mutex even when accessing that
599 * list. And freeing mark requires us to drop mark_mutex. So we can
600 * reliably free only the first mark in the list. That's why we first
601 * move marks to free to to_free list in one go and then free marks in
602 * to_free list one by one.
603 */
Lino Sanfilippo6960b0d2011-08-12 01:13:31 +0200604 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
Eric Paris5444e292009-12-17 21:24:27 -0500605 list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
Jan Kara86ffe242017-03-14 14:29:35 +0100606 if (mark->connector->flags & flags)
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700607 list_move(&mark->g_list, &to_free);
Eric Paris5444e292009-12-17 21:24:27 -0500608 }
Lino Sanfilippo986ab092011-06-14 17:29:50 +0200609 mutex_unlock(&group->mark_mutex);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700610
611 while (1) {
612 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
613 if (list_empty(&to_free)) {
614 mutex_unlock(&group->mark_mutex);
615 break;
616 }
617 mark = list_first_entry(&to_free, struct fsnotify_mark, g_list);
618 fsnotify_get_mark(mark);
Jan Kara4712e7222015-09-04 15:43:12 -0700619 fsnotify_detach_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700620 mutex_unlock(&group->mark_mutex);
Jan Kara4712e7222015-09-04 15:43:12 -0700621 fsnotify_free_mark(mark);
Jan Kara8f2f3eb2015-08-06 15:46:42 -0700622 fsnotify_put_mark(mark);
623 }
Eric Paris5444e292009-12-17 21:24:27 -0500624}
625
Eric Paris4d926042009-12-17 21:24:34 -0500626/*
Jan Kara35e48172016-05-19 17:08:59 -0700627 * Given a group, prepare for freeing all the marks associated with that group.
628 * The marks are attached to the list of marks prepared for destruction, the
629 * caller is responsible for freeing marks in that list after SRCU period has
630 * ended.
Eric Paris4d926042009-12-17 21:24:34 -0500631 */
Jan Kara35e48172016-05-19 17:08:59 -0700632void fsnotify_detach_group_marks(struct fsnotify_group *group)
Eric Paris4d926042009-12-17 21:24:34 -0500633{
Jan Kara35e48172016-05-19 17:08:59 -0700634 struct fsnotify_mark *mark;
635
636 while (1) {
637 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
638 if (list_empty(&group->marks_list)) {
639 mutex_unlock(&group->mark_mutex);
640 break;
641 }
642 mark = list_first_entry(&group->marks_list,
643 struct fsnotify_mark, g_list);
644 fsnotify_get_mark(mark);
645 fsnotify_detach_mark(mark);
646 mutex_unlock(&group->mark_mutex);
Jan Kara11375142016-11-09 14:54:20 +0100647 fsnotify_free_mark(mark);
Jan Kara35e48172016-05-19 17:08:59 -0700648 fsnotify_put_mark(mark);
649 }
Eric Paris4d926042009-12-17 21:24:34 -0500650}
651
Jan Kara08991e82017-02-01 09:21:58 +0100652/* Destroy all marks attached to inode / vfsmount */
653void fsnotify_destroy_marks(struct fsnotify_mark_connector __rcu **connp)
Jan Kara0810b4f2017-02-01 09:23:48 +0100654{
Jan Kara08991e82017-02-01 09:21:58 +0100655 struct fsnotify_mark_connector *conn;
Jan Kara6b3f05d2016-12-21 12:15:30 +0100656 struct fsnotify_mark *mark, *old_mark = NULL;
657 struct inode *inode;
Jan Kara0810b4f2017-02-01 09:23:48 +0100658
Jan Kara6b3f05d2016-12-21 12:15:30 +0100659 conn = fsnotify_grab_connector(connp);
660 if (!conn)
661 return;
662 /*
663 * We have to be careful since we can race with e.g.
664 * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
665 * list can get modified. However we are holding mark reference and
666 * thus our mark cannot be removed from obj_list so we can continue
667 * iteration after regaining conn->lock.
668 */
669 hlist_for_each_entry(mark, &conn->list, obj_list) {
Jan Kara0810b4f2017-02-01 09:23:48 +0100670 fsnotify_get_mark(mark);
Jan Kara04662ca2017-02-01 08:19:43 +0100671 spin_unlock(&conn->lock);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100672 if (old_mark)
673 fsnotify_put_mark(old_mark);
674 old_mark = mark;
Jan Kara0810b4f2017-02-01 09:23:48 +0100675 fsnotify_destroy_mark(mark, mark->group);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100676 spin_lock(&conn->lock);
Jan Kara0810b4f2017-02-01 09:23:48 +0100677 }
Jan Kara6b3f05d2016-12-21 12:15:30 +0100678 /*
679 * Detach list from object now so that we don't pin inode until all
680 * mark references get dropped. It would lead to strange results such
681 * as delaying inode deletion or blocking unmount.
682 */
683 inode = fsnotify_detach_connector_from_object(conn);
684 spin_unlock(&conn->lock);
685 if (old_mark)
686 fsnotify_put_mark(old_mark);
687 iput(inode);
Jan Kara0810b4f2017-02-01 09:23:48 +0100688}
689
Eric Paris5444e292009-12-17 21:24:27 -0500690/*
691 * Nothing fancy, just initialize lists and locks and counters.
692 */
693void fsnotify_init_mark(struct fsnotify_mark *mark,
694 void (*free_mark)(struct fsnotify_mark *mark))
695{
Eric Parisba643f02009-12-17 21:24:27 -0500696 memset(mark, 0, sizeof(*mark));
Eric Paris5444e292009-12-17 21:24:27 -0500697 spin_lock_init(&mark->lock);
698 atomic_set(&mark->refcnt, 1);
Eric Paris5444e292009-12-17 21:24:27 -0500699 mark->free_mark = free_mark;
700}
Jeff Layton13d34ac2016-02-17 13:11:18 -0800701
Jan Kara35e48172016-05-19 17:08:59 -0700702/*
703 * Destroy all marks in destroy_list, waits for SRCU period to finish before
704 * actually freeing marks.
705 */
Jan Karaf09b04a2016-12-21 14:48:18 +0100706static void fsnotify_mark_destroy_workfn(struct work_struct *work)
Jeff Layton13d34ac2016-02-17 13:11:18 -0800707{
708 struct fsnotify_mark *mark, *next;
709 struct list_head private_destroy_list;
710
Jeff Layton0918f1c2016-02-17 13:11:21 -0800711 spin_lock(&destroy_lock);
712 /* exchange the list head */
713 list_replace_init(&destroy_list, &private_destroy_list);
714 spin_unlock(&destroy_lock);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800715
Jeff Layton0918f1c2016-02-17 13:11:21 -0800716 synchronize_srcu(&fsnotify_mark_srcu);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800717
Jeff Layton0918f1c2016-02-17 13:11:21 -0800718 list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
719 list_del_init(&mark->g_list);
Jan Kara6b3f05d2016-12-21 12:15:30 +0100720 fsnotify_final_mark_destroy(mark);
Jeff Layton13d34ac2016-02-17 13:11:18 -0800721 }
Jeff Layton13d34ac2016-02-17 13:11:18 -0800722}
Jan Kara35e48172016-05-19 17:08:59 -0700723
Jan Karaf09b04a2016-12-21 14:48:18 +0100724/* Wait for all marks queued for destruction to be actually destroyed */
725void fsnotify_wait_marks_destroyed(void)
Jan Kara35e48172016-05-19 17:08:59 -0700726{
Jan Karaf09b04a2016-12-21 14:48:18 +0100727 flush_delayed_work(&reaper_work);
Jan Kara35e48172016-05-19 17:08:59 -0700728}