xref: /linux/fs/notify/fsnotify.c (revision 8c67da5bc11a79833d9fd464e82b1b271c67fc87)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
4  */
5 
6 #include <linux/dcache.h>
7 #include <linux/fs.h>
8 #include <linux/gfp.h>
9 #include <linux/init.h>
10 #include <linux/module.h>
11 #include <linux/mount.h>
12 #include <linux/srcu.h>
13 
14 #include <linux/fsnotify_backend.h>
15 #include "fsnotify.h"
16 
17 /*
18  * Clear all of the marks on an inode when it is being evicted from core
19  */
__fsnotify_inode_delete(struct inode * inode)20 void __fsnotify_inode_delete(struct inode *inode)
21 {
22 	fsnotify_clear_marks_by_inode(inode);
23 }
24 EXPORT_SYMBOL_GPL(__fsnotify_inode_delete);
25 
__fsnotify_vfsmount_delete(struct vfsmount * mnt)26 void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
27 {
28 	fsnotify_clear_marks_by_mount(mnt);
29 }
30 
31 /**
32  * fsnotify_unmount_inodes - an sb is unmounting.  handle any watched inodes.
33  * @sb: superblock being unmounted.
34  *
35  * Called during unmount with no locks held, so needs to be safe against
36  * concurrent modifiers. We temporarily drop sb->s_inode_list_lock and CAN block.
37  */
fsnotify_unmount_inodes(struct super_block * sb)38 static void fsnotify_unmount_inodes(struct super_block *sb)
39 {
40 	struct inode *inode, *iput_inode = NULL;
41 
42 	spin_lock(&sb->s_inode_list_lock);
43 	list_for_each_entry(inode, &sb->s_inodes, i_sb_list) {
44 		/*
45 		 * We cannot __iget() an inode in state I_FREEING,
46 		 * I_WILL_FREE, or I_NEW which is fine because by that point
47 		 * the inode cannot have any associated watches.
48 		 */
49 		spin_lock(&inode->i_lock);
50 		if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW)) {
51 			spin_unlock(&inode->i_lock);
52 			continue;
53 		}
54 
55 		/*
56 		 * If i_count is zero, the inode cannot have any watches and
57 		 * doing an __iget/iput with SB_ACTIVE clear would actually
58 		 * evict all inodes with zero i_count from icache which is
59 		 * unnecessarily violent and may in fact be illegal to do.
60 		 * However, we should have been called /after/ evict_inodes
61 		 * removed all zero refcount inodes, in any case.  Test to
62 		 * be sure.
63 		 */
64 		if (!atomic_read(&inode->i_count)) {
65 			spin_unlock(&inode->i_lock);
66 			continue;
67 		}
68 
69 		__iget(inode);
70 		spin_unlock(&inode->i_lock);
71 		spin_unlock(&sb->s_inode_list_lock);
72 
73 		iput(iput_inode);
74 
75 		/* for each watch, send FS_UNMOUNT and then remove it */
76 		fsnotify_inode(inode, FS_UNMOUNT);
77 
78 		fsnotify_inode_delete(inode);
79 
80 		iput_inode = inode;
81 
82 		cond_resched();
83 		spin_lock(&sb->s_inode_list_lock);
84 	}
85 	spin_unlock(&sb->s_inode_list_lock);
86 
87 	iput(iput_inode);
88 }
89 
fsnotify_sb_delete(struct super_block * sb)90 void fsnotify_sb_delete(struct super_block *sb)
91 {
92 	struct fsnotify_sb_info *sbinfo = fsnotify_sb_info(sb);
93 
94 	/* Were any marks ever added to any object on this sb? */
95 	if (!sbinfo)
96 		return;
97 
98 	fsnotify_unmount_inodes(sb);
99 	fsnotify_clear_marks_by_sb(sb);
100 	/* Wait for outstanding object references from connectors */
101 	wait_var_event(fsnotify_sb_watched_objects(sb),
102 		       !atomic_long_read(fsnotify_sb_watched_objects(sb)));
103 	WARN_ON(fsnotify_sb_has_priority_watchers(sb, FSNOTIFY_PRIO_CONTENT));
104 	WARN_ON(fsnotify_sb_has_priority_watchers(sb,
105 						  FSNOTIFY_PRIO_PRE_CONTENT));
106 }
107 
fsnotify_sb_free(struct super_block * sb)108 void fsnotify_sb_free(struct super_block *sb)
109 {
110 	kfree(sb->s_fsnotify_info);
111 }
112 
113 /*
114  * Given an inode, first check if we care what happens to our children.  Inotify
115  * and dnotify both tell their parents about events.  If we care about any event
116  * on a child we run all of our children and set a dentry flag saying that the
117  * parent cares.  Thus when an event happens on a child it can quickly tell
118  * if there is a need to find a parent and send the event to the parent.
119  */
fsnotify_set_children_dentry_flags(struct inode * inode)120 void fsnotify_set_children_dentry_flags(struct inode *inode)
121 {
122 	struct dentry *alias;
123 
124 	if (!S_ISDIR(inode->i_mode))
125 		return;
126 
127 	spin_lock(&inode->i_lock);
128 	/* run all of the dentries associated with this inode.  Since this is a
129 	 * directory, there damn well better only be one item on this list */
130 	hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
131 		struct dentry *child;
132 
133 		/* run all of the children of the original inode and fix their
134 		 * d_flags to indicate parental interest (their parent is the
135 		 * original inode) */
136 		spin_lock(&alias->d_lock);
137 		hlist_for_each_entry(child, &alias->d_children, d_sib) {
138 			if (!child->d_inode)
139 				continue;
140 
141 			spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
142 			child->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
143 			spin_unlock(&child->d_lock);
144 		}
145 		spin_unlock(&alias->d_lock);
146 	}
147 	spin_unlock(&inode->i_lock);
148 }
149 
150 /*
151  * Lazily clear false positive PARENT_WATCHED flag for child whose parent had
152  * stopped watching children.
153  */
fsnotify_clear_child_dentry_flag(struct inode * pinode,struct dentry * dentry)154 static void fsnotify_clear_child_dentry_flag(struct inode *pinode,
155 					     struct dentry *dentry)
156 {
157 	spin_lock(&dentry->d_lock);
158 	/*
159 	 * d_lock is a sufficient barrier to prevent observing a non-watched
160 	 * parent state from before the fsnotify_set_children_dentry_flags()
161 	 * or fsnotify_update_flags() call that had set PARENT_WATCHED.
162 	 */
163 	if (!fsnotify_inode_watches_children(pinode))
164 		dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
165 	spin_unlock(&dentry->d_lock);
166 }
167 
168 /* Are inode/sb/mount interested in parent and name info with this event? */
fsnotify_event_needs_parent(struct inode * inode,__u32 mnt_mask,__u32 mask)169 static bool fsnotify_event_needs_parent(struct inode *inode, __u32 mnt_mask,
170 					__u32 mask)
171 {
172 	__u32 marks_mask = 0;
173 
174 	/* We only send parent/name to inode/sb/mount for events on non-dir */
175 	if (mask & FS_ISDIR)
176 		return false;
177 
178 	/*
179 	 * All events that are possible on child can also may be reported with
180 	 * parent/name info to inode/sb/mount.  Otherwise, a watching parent
181 	 * could result in events reported with unexpected name info to sb/mount.
182 	 */
183 	BUILD_BUG_ON(FS_EVENTS_POSS_ON_CHILD & ~FS_EVENTS_POSS_TO_PARENT);
184 
185 	/* Did either inode/sb/mount subscribe for events with parent/name? */
186 	marks_mask |= fsnotify_parent_needed_mask(
187 				READ_ONCE(inode->i_fsnotify_mask));
188 	marks_mask |= fsnotify_parent_needed_mask(
189 				READ_ONCE(inode->i_sb->s_fsnotify_mask));
190 	marks_mask |= fsnotify_parent_needed_mask(mnt_mask);
191 
192 	/* Did they subscribe for this event with parent/name info? */
193 	return mask & marks_mask;
194 }
195 
196 /* Are there any inode/mount/sb objects that watch for these events? */
fsnotify_object_watched(struct inode * inode,__u32 mnt_mask,__u32 mask)197 static inline bool fsnotify_object_watched(struct inode *inode, __u32 mnt_mask,
198 					   __u32 mask)
199 {
200 	__u32 marks_mask = READ_ONCE(inode->i_fsnotify_mask) | mnt_mask |
201 			   READ_ONCE(inode->i_sb->s_fsnotify_mask);
202 
203 	return mask & marks_mask & ALL_FSNOTIFY_EVENTS;
204 }
205 
206 /* Report pre-content event with optional range info */
fsnotify_pre_content(const struct path * path,const loff_t * ppos,size_t count)207 int fsnotify_pre_content(const struct path *path, const loff_t *ppos,
208 			 size_t count)
209 {
210 	struct file_range range;
211 
212 	/* Report page aligned range only when pos is known */
213 	if (!ppos)
214 		return fsnotify_path(path, FS_PRE_ACCESS);
215 
216 	range.path = path;
217 	range.pos = PAGE_ALIGN_DOWN(*ppos);
218 	range.count = PAGE_ALIGN(*ppos + count) - range.pos;
219 
220 	return fsnotify_parent(path->dentry, FS_PRE_ACCESS, &range,
221 			       FSNOTIFY_EVENT_FILE_RANGE);
222 }
223 
224 /*
225  * Notify this dentry's parent about a child's events with child name info
226  * if parent is watching or if inode/sb/mount are interested in events with
227  * parent and name info.
228  *
229  * Notify only the child without name info if parent is not watching and
230  * inode/sb/mount are not interested in events with parent and name info.
231  */
__fsnotify_parent(struct dentry * dentry,__u32 mask,const void * data,int data_type)232 int __fsnotify_parent(struct dentry *dentry, __u32 mask, const void *data,
233 		      int data_type)
234 {
235 	const struct path *path = fsnotify_data_path(data, data_type);
236 	__u32 mnt_mask = path ?
237 		READ_ONCE(real_mount(path->mnt)->mnt_fsnotify_mask) : 0;
238 	struct inode *inode = d_inode(dentry);
239 	struct dentry *parent;
240 	bool parent_watched = dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED;
241 	bool parent_needed, parent_interested;
242 	__u32 p_mask;
243 	struct inode *p_inode = NULL;
244 	struct name_snapshot name;
245 	struct qstr *file_name = NULL;
246 	int ret = 0;
247 
248 	/* Optimize the likely case of nobody watching this path */
249 	if (likely(!parent_watched &&
250 		   !fsnotify_object_watched(inode, mnt_mask, mask)))
251 		return 0;
252 
253 	parent = NULL;
254 	parent_needed = fsnotify_event_needs_parent(inode, mnt_mask, mask);
255 	if (!parent_watched && !parent_needed)
256 		goto notify;
257 
258 	/* Does parent inode care about events on children? */
259 	parent = dget_parent(dentry);
260 	p_inode = parent->d_inode;
261 	p_mask = fsnotify_inode_watches_children(p_inode);
262 	if (unlikely(parent_watched && !p_mask))
263 		fsnotify_clear_child_dentry_flag(p_inode, dentry);
264 
265 	/*
266 	 * Include parent/name in notification either if some notification
267 	 * groups require parent info or the parent is interested in this event.
268 	 */
269 	parent_interested = mask & p_mask & ALL_FSNOTIFY_EVENTS;
270 	if (parent_needed || parent_interested) {
271 		/* When notifying parent, child should be passed as data */
272 		WARN_ON_ONCE(inode != fsnotify_data_inode(data, data_type));
273 
274 		/* Notify both parent and child with child name info */
275 		take_dentry_name_snapshot(&name, dentry);
276 		file_name = &name.name;
277 		if (parent_interested)
278 			mask |= FS_EVENT_ON_CHILD;
279 	}
280 
281 notify:
282 	ret = fsnotify(mask, data, data_type, p_inode, file_name, inode, 0);
283 
284 	if (file_name)
285 		release_dentry_name_snapshot(&name);
286 	dput(parent);
287 
288 	return ret;
289 }
290 EXPORT_SYMBOL_GPL(__fsnotify_parent);
291 
fsnotify_handle_inode_event(struct fsnotify_group * group,struct fsnotify_mark * inode_mark,u32 mask,const void * data,int data_type,struct inode * dir,const struct qstr * name,u32 cookie)292 static int fsnotify_handle_inode_event(struct fsnotify_group *group,
293 				       struct fsnotify_mark *inode_mark,
294 				       u32 mask, const void *data, int data_type,
295 				       struct inode *dir, const struct qstr *name,
296 				       u32 cookie)
297 {
298 	const struct path *path = fsnotify_data_path(data, data_type);
299 	struct inode *inode = fsnotify_data_inode(data, data_type);
300 	const struct fsnotify_ops *ops = group->ops;
301 
302 	if (WARN_ON_ONCE(!ops->handle_inode_event))
303 		return 0;
304 
305 	if (WARN_ON_ONCE(!inode && !dir))
306 		return 0;
307 
308 	if ((inode_mark->flags & FSNOTIFY_MARK_FLAG_EXCL_UNLINK) &&
309 	    path && d_unlinked(path->dentry))
310 		return 0;
311 
312 	/* Check interest of this mark in case event was sent with two marks */
313 	if (!(mask & inode_mark->mask & ALL_FSNOTIFY_EVENTS))
314 		return 0;
315 
316 	return ops->handle_inode_event(inode_mark, mask, inode, dir, name, cookie);
317 }
318 
fsnotify_handle_event(struct fsnotify_group * group,__u32 mask,const void * data,int data_type,struct inode * dir,const struct qstr * name,u32 cookie,struct fsnotify_iter_info * iter_info)319 static int fsnotify_handle_event(struct fsnotify_group *group, __u32 mask,
320 				 const void *data, int data_type,
321 				 struct inode *dir, const struct qstr *name,
322 				 u32 cookie, struct fsnotify_iter_info *iter_info)
323 {
324 	struct fsnotify_mark *inode_mark = fsnotify_iter_inode_mark(iter_info);
325 	struct fsnotify_mark *parent_mark = fsnotify_iter_parent_mark(iter_info);
326 	int ret;
327 
328 	if (WARN_ON_ONCE(fsnotify_iter_sb_mark(iter_info)) ||
329 	    WARN_ON_ONCE(fsnotify_iter_vfsmount_mark(iter_info)))
330 		return 0;
331 
332 	/*
333 	 * For FS_RENAME, 'dir' is old dir and 'data' is new dentry.
334 	 * The only ->handle_inode_event() backend that supports FS_RENAME is
335 	 * dnotify, where it means file was renamed within same parent.
336 	 */
337 	if (mask & FS_RENAME) {
338 		struct dentry *moved = fsnotify_data_dentry(data, data_type);
339 
340 		if (dir != moved->d_parent->d_inode)
341 			return 0;
342 	}
343 
344 	if (parent_mark) {
345 		ret = fsnotify_handle_inode_event(group, parent_mark, mask,
346 						  data, data_type, dir, name, 0);
347 		if (ret)
348 			return ret;
349 	}
350 
351 	if (!inode_mark)
352 		return 0;
353 
354 	/*
355 	 * Some events can be sent on both parent dir and child marks (e.g.
356 	 * FS_ATTRIB).  If both parent dir and child are watching, report the
357 	 * event once to parent dir with name (if interested) and once to child
358 	 * without name (if interested).
359 	 *
360 	 * In any case regardless whether the parent is watching or not, the
361 	 * child watcher is expecting an event without the FS_EVENT_ON_CHILD
362 	 * flag. The file name is expected if and only if this is a directory
363 	 * event.
364 	 */
365 	mask &= ~FS_EVENT_ON_CHILD;
366 	if (!(mask & ALL_FSNOTIFY_DIRENT_EVENTS)) {
367 		dir = NULL;
368 		name = NULL;
369 	}
370 
371 	return fsnotify_handle_inode_event(group, inode_mark, mask, data, data_type,
372 					   dir, name, cookie);
373 }
374 
send_to_group(__u32 mask,const void * data,int data_type,struct inode * dir,const struct qstr * file_name,u32 cookie,struct fsnotify_iter_info * iter_info)375 static int send_to_group(__u32 mask, const void *data, int data_type,
376 			 struct inode *dir, const struct qstr *file_name,
377 			 u32 cookie, struct fsnotify_iter_info *iter_info)
378 {
379 	struct fsnotify_group *group = NULL;
380 	__u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
381 	__u32 marks_mask = 0;
382 	__u32 marks_ignore_mask = 0;
383 	bool is_dir = mask & FS_ISDIR;
384 	struct fsnotify_mark *mark;
385 	int type;
386 
387 	if (!iter_info->report_mask)
388 		return 0;
389 
390 	/* clear ignored on inode modification */
391 	if (mask & FS_MODIFY) {
392 		fsnotify_foreach_iter_mark_type(iter_info, mark, type) {
393 			if (!(mark->flags &
394 			      FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
395 				mark->ignore_mask = 0;
396 		}
397 	}
398 
399 	/* Are any of the group marks interested in this event? */
400 	fsnotify_foreach_iter_mark_type(iter_info, mark, type) {
401 		group = mark->group;
402 		marks_mask |= mark->mask;
403 		marks_ignore_mask |=
404 			fsnotify_effective_ignore_mask(mark, is_dir, type);
405 	}
406 
407 	pr_debug("%s: group=%p mask=%x marks_mask=%x marks_ignore_mask=%x data=%p data_type=%d dir=%p cookie=%d\n",
408 		 __func__, group, mask, marks_mask, marks_ignore_mask,
409 		 data, data_type, dir, cookie);
410 
411 	if (!(test_mask & marks_mask & ~marks_ignore_mask))
412 		return 0;
413 
414 	if (group->ops->handle_event) {
415 		return group->ops->handle_event(group, mask, data, data_type, dir,
416 						file_name, cookie, iter_info);
417 	}
418 
419 	return fsnotify_handle_event(group, mask, data, data_type, dir,
420 				     file_name, cookie, iter_info);
421 }
422 
fsnotify_first_mark(struct fsnotify_mark_connector ** connp)423 static struct fsnotify_mark *fsnotify_first_mark(struct fsnotify_mark_connector **connp)
424 {
425 	struct fsnotify_mark_connector *conn;
426 	struct hlist_node *node = NULL;
427 
428 	conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
429 	if (conn)
430 		node = srcu_dereference(conn->list.first, &fsnotify_mark_srcu);
431 
432 	return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
433 }
434 
fsnotify_next_mark(struct fsnotify_mark * mark)435 static struct fsnotify_mark *fsnotify_next_mark(struct fsnotify_mark *mark)
436 {
437 	struct hlist_node *node = NULL;
438 
439 	if (mark)
440 		node = srcu_dereference(mark->obj_list.next,
441 					&fsnotify_mark_srcu);
442 
443 	return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
444 }
445 
446 /*
447  * iter_info is a multi head priority queue of marks.
448  * Pick a subset of marks from queue heads, all with the same group
449  * and set the report_mask to a subset of the selected marks.
450  * Returns false if there are no more groups to iterate.
451  */
fsnotify_iter_select_report_types(struct fsnotify_iter_info * iter_info)452 static bool fsnotify_iter_select_report_types(
453 		struct fsnotify_iter_info *iter_info)
454 {
455 	struct fsnotify_group *max_prio_group = NULL;
456 	struct fsnotify_mark *mark;
457 	int type;
458 
459 	/* Choose max prio group among groups of all queue heads */
460 	fsnotify_foreach_iter_type(type) {
461 		mark = iter_info->marks[type];
462 		if (mark &&
463 		    fsnotify_compare_groups(max_prio_group, mark->group) > 0)
464 			max_prio_group = mark->group;
465 	}
466 
467 	if (!max_prio_group)
468 		return false;
469 
470 	/* Set the report mask for marks from same group as max prio group */
471 	iter_info->current_group = max_prio_group;
472 	iter_info->report_mask = 0;
473 	fsnotify_foreach_iter_type(type) {
474 		mark = iter_info->marks[type];
475 		if (mark && mark->group == iter_info->current_group) {
476 			/*
477 			 * FSNOTIFY_ITER_TYPE_PARENT indicates that this inode
478 			 * is watching children and interested in this event,
479 			 * which is an event possible on child.
480 			 * But is *this mark* watching children?
481 			 */
482 			if (type == FSNOTIFY_ITER_TYPE_PARENT &&
483 			    !(mark->mask & FS_EVENT_ON_CHILD) &&
484 			    !(fsnotify_ignore_mask(mark) & FS_EVENT_ON_CHILD))
485 				continue;
486 
487 			fsnotify_iter_set_report_type(iter_info, type);
488 		}
489 	}
490 
491 	return true;
492 }
493 
494 /*
495  * Pop from iter_info multi head queue, the marks that belong to the group of
496  * current iteration step.
497  */
fsnotify_iter_next(struct fsnotify_iter_info * iter_info)498 static void fsnotify_iter_next(struct fsnotify_iter_info *iter_info)
499 {
500 	struct fsnotify_mark *mark;
501 	int type;
502 
503 	/*
504 	 * We cannot use fsnotify_foreach_iter_mark_type() here because we
505 	 * may need to advance a mark of type X that belongs to current_group
506 	 * but was not selected for reporting.
507 	 */
508 	fsnotify_foreach_iter_type(type) {
509 		mark = iter_info->marks[type];
510 		if (mark && mark->group == iter_info->current_group)
511 			iter_info->marks[type] =
512 				fsnotify_next_mark(iter_info->marks[type]);
513 	}
514 }
515 
516 /*
517  * fsnotify - This is the main call to fsnotify.
518  *
519  * The VFS calls into hook specific functions in linux/fsnotify.h.
520  * Those functions then in turn call here.  Here will call out to all of the
521  * registered fsnotify_group.  Those groups can then use the notification event
522  * in whatever means they feel necessary.
523  *
524  * @mask:	event type and flags
525  * @data:	object that event happened on
526  * @data_type:	type of object for fanotify_data_XXX() accessors
527  * @dir:	optional directory associated with event -
528  *		if @file_name is not NULL, this is the directory that
529  *		@file_name is relative to
530  * @file_name:	optional file name associated with event
531  * @inode:	optional inode associated with event -
532  *		If @dir and @inode are both non-NULL, event may be
533  *		reported to both.
534  * @cookie:	inotify rename cookie
535  */
fsnotify(__u32 mask,const void * data,int data_type,struct inode * dir,const struct qstr * file_name,struct inode * inode,u32 cookie)536 int fsnotify(__u32 mask, const void *data, int data_type, struct inode *dir,
537 	     const struct qstr *file_name, struct inode *inode, u32 cookie)
538 {
539 	const struct path *path = fsnotify_data_path(data, data_type);
540 	struct super_block *sb = fsnotify_data_sb(data, data_type);
541 	struct fsnotify_sb_info *sbinfo = fsnotify_sb_info(sb);
542 	struct fsnotify_iter_info iter_info = {};
543 	struct mount *mnt = NULL;
544 	struct inode *inode2 = NULL;
545 	struct dentry *moved;
546 	int inode2_type;
547 	int ret = 0;
548 	__u32 test_mask, marks_mask;
549 
550 	if (path)
551 		mnt = real_mount(path->mnt);
552 
553 	if (!inode) {
554 		/* Dirent event - report on TYPE_INODE to dir */
555 		inode = dir;
556 		/* For FS_RENAME, inode is old_dir and inode2 is new_dir */
557 		if (mask & FS_RENAME) {
558 			moved = fsnotify_data_dentry(data, data_type);
559 			inode2 = moved->d_parent->d_inode;
560 			inode2_type = FSNOTIFY_ITER_TYPE_INODE2;
561 		}
562 	} else if (mask & FS_EVENT_ON_CHILD) {
563 		/*
564 		 * Event on child - report on TYPE_PARENT to dir if it is
565 		 * watching children and on TYPE_INODE to child.
566 		 */
567 		inode2 = dir;
568 		inode2_type = FSNOTIFY_ITER_TYPE_PARENT;
569 	}
570 
571 	/*
572 	 * Optimization: srcu_read_lock() has a memory barrier which can
573 	 * be expensive.  It protects walking the *_fsnotify_marks lists.
574 	 * However, if we do not walk the lists, we do not have to do
575 	 * SRCU because we have no references to any objects and do not
576 	 * need SRCU to keep them "alive".
577 	 */
578 	if ((!sbinfo || !sbinfo->sb_marks) &&
579 	    (!mnt || !mnt->mnt_fsnotify_marks) &&
580 	    (!inode || !inode->i_fsnotify_marks) &&
581 	    (!inode2 || !inode2->i_fsnotify_marks))
582 		return 0;
583 
584 	marks_mask = READ_ONCE(sb->s_fsnotify_mask);
585 	if (mnt)
586 		marks_mask |= READ_ONCE(mnt->mnt_fsnotify_mask);
587 	if (inode)
588 		marks_mask |= READ_ONCE(inode->i_fsnotify_mask);
589 	if (inode2)
590 		marks_mask |= READ_ONCE(inode2->i_fsnotify_mask);
591 
592 
593 	/*
594 	 * If this is a modify event we may need to clear some ignore masks.
595 	 * In that case, the object with ignore masks will have the FS_MODIFY
596 	 * event in its mask.
597 	 * Otherwise, return if none of the marks care about this type of event.
598 	 */
599 	test_mask = (mask & ALL_FSNOTIFY_EVENTS);
600 	if (!(test_mask & marks_mask))
601 		return 0;
602 
603 	iter_info.srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
604 
605 	if (sbinfo) {
606 		iter_info.marks[FSNOTIFY_ITER_TYPE_SB] =
607 			fsnotify_first_mark(&sbinfo->sb_marks);
608 	}
609 	if (mnt) {
610 		iter_info.marks[FSNOTIFY_ITER_TYPE_VFSMOUNT] =
611 			fsnotify_first_mark(&mnt->mnt_fsnotify_marks);
612 	}
613 	if (inode) {
614 		iter_info.marks[FSNOTIFY_ITER_TYPE_INODE] =
615 			fsnotify_first_mark(&inode->i_fsnotify_marks);
616 	}
617 	if (inode2) {
618 		iter_info.marks[inode2_type] =
619 			fsnotify_first_mark(&inode2->i_fsnotify_marks);
620 	}
621 
622 	/*
623 	 * We need to merge inode/vfsmount/sb mark lists so that e.g. inode mark
624 	 * ignore masks are properly reflected for mount/sb mark notifications.
625 	 * That's why this traversal is so complicated...
626 	 */
627 	while (fsnotify_iter_select_report_types(&iter_info)) {
628 		ret = send_to_group(mask, data, data_type, dir, file_name,
629 				    cookie, &iter_info);
630 
631 		if (ret && (mask & ALL_FSNOTIFY_PERM_EVENTS))
632 			goto out;
633 
634 		fsnotify_iter_next(&iter_info);
635 	}
636 	ret = 0;
637 out:
638 	srcu_read_unlock(&fsnotify_mark_srcu, iter_info.srcu_idx);
639 
640 	return ret;
641 }
642 EXPORT_SYMBOL_GPL(fsnotify);
643 
644 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
645 /*
646  * At open time we check fsnotify_sb_has_priority_watchers() and set the
647  * FMODE_NONOTIFY_ mode bits accordignly.
648  * Later, fsnotify permission hooks do not check if there are permission event
649  * watches, but that there were permission event watches at open time.
650  */
file_set_fsnotify_mode_from_watchers(struct file * file)651 void file_set_fsnotify_mode_from_watchers(struct file *file)
652 {
653 	struct dentry *dentry = file->f_path.dentry, *parent;
654 	struct super_block *sb = dentry->d_sb;
655 	__u32 mnt_mask, p_mask;
656 
657 	/* Is it a file opened by fanotify? */
658 	if (FMODE_FSNOTIFY_NONE(file->f_mode))
659 		return;
660 
661 	/*
662 	 * Permission events is a super set of pre-content events, so if there
663 	 * are no permission event watchers, there are also no pre-content event
664 	 * watchers and this is implied from the single FMODE_NONOTIFY_PERM bit.
665 	 */
666 	if (likely(!fsnotify_sb_has_priority_watchers(sb,
667 						FSNOTIFY_PRIO_CONTENT))) {
668 		file_set_fsnotify_mode(file, FMODE_NONOTIFY_PERM);
669 		return;
670 	}
671 
672 	/*
673 	 * If there are permission event watchers but no pre-content event
674 	 * watchers, set FMODE_NONOTIFY | FMODE_NONOTIFY_PERM to indicate that.
675 	 */
676 	if ((!d_is_dir(dentry) && !d_is_reg(dentry)) ||
677 	    likely(!fsnotify_sb_has_priority_watchers(sb,
678 						FSNOTIFY_PRIO_PRE_CONTENT))) {
679 		file_set_fsnotify_mode(file, FMODE_NONOTIFY | FMODE_NONOTIFY_PERM);
680 		return;
681 	}
682 
683 	/*
684 	 * OK, there are some pre-content watchers. Check if anybody is
685 	 * watching for pre-content events on *this* file.
686 	 */
687 	mnt_mask = READ_ONCE(real_mount(file->f_path.mnt)->mnt_fsnotify_mask);
688 	if (unlikely(fsnotify_object_watched(d_inode(dentry), mnt_mask,
689 				     FSNOTIFY_PRE_CONTENT_EVENTS))) {
690 		/* Enable pre-content events */
691 		file_set_fsnotify_mode(file, 0);
692 		return;
693 	}
694 
695 	/* Is parent watching for pre-content events on this file? */
696 	if (dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED) {
697 		parent = dget_parent(dentry);
698 		p_mask = fsnotify_inode_watches_children(d_inode(parent));
699 		dput(parent);
700 		if (p_mask & FSNOTIFY_PRE_CONTENT_EVENTS) {
701 			/* Enable pre-content events */
702 			file_set_fsnotify_mode(file, 0);
703 			return;
704 		}
705 	}
706 	/* Nobody watching for pre-content events from this file */
707 	file_set_fsnotify_mode(file, FMODE_NONOTIFY | FMODE_NONOTIFY_PERM);
708 }
709 #endif
710 
fsnotify_init(void)711 static __init int fsnotify_init(void)
712 {
713 	int ret;
714 
715 	BUILD_BUG_ON(HWEIGHT32(ALL_FSNOTIFY_BITS) != 24);
716 
717 	ret = init_srcu_struct(&fsnotify_mark_srcu);
718 	if (ret)
719 		panic("initializing fsnotify_mark_srcu");
720 
721 	fsnotify_mark_connector_cachep = KMEM_CACHE(fsnotify_mark_connector,
722 						    SLAB_PANIC);
723 
724 	return 0;
725 }
726 core_initcall(fsnotify_init);
727