Received-SPF: pass (google.com: domain of linux-kernel+bounces-176269-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: Stephen Brennan <stephen.s.brennan@oracle.com>
To: Jan Kara <jack@suse.cz>
Cc: Amir Goldstein <amir73il@gmail.com>, linux-fsdevel@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Stephen Brennan <stephen.s.brennan@oracle.com>
Subject: [PATCH 1/1] fsnotify: clear PARENT_WATCHED flags lazily
Date: Fri, 10 May 2024 15:19:00 -0700
Message-ID: <20240510221901.520546-2-stephen.s.brennan@oracle.com>
In-Reply-To: <20240510221901.520546-1-stephen.s.brennan@oracle.com>
References: <20240510221901.520546-1-stephen.s.brennan@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: 
	=?us-ascii?Q?MrL7+3PJz0OwgvP8V3CuY1XBxbFjRJCbwgFCKjezaLhktDLbGp7Z2ASmpKoF?=
 =?us-ascii?Q?YsNmrT8/pHhKZBvauqGbTC51bGz4fii9gL+He5RnYFA7lprHJjz7hegyCYpR?=
 =?us-ascii?Q?rAoBfYruAxZPtQqZirDLU8npxPyhjQEYhjZUdP3Z4CEFlfY16Bv1hBO25/HT?=
 =?us-ascii?Q?AUCSp2JqTJxdWxYEWQq7LR/97dobkgPAoVknBvnoO/mfXwyaXt+8qG8UaP/0?=
 =?us-ascii?Q?puaW45FIytKL77r5lXaoQuVDmOKS1JelUIVZyyKbNp+4/vXC3zJJqW2BEHy7?=
 =?us-ascii?Q?Kvcb6XpP7S62WtPI/DZ2+ZBBT/dCFLdjRoJOq5TURuAALvCeeNSexpU4PJSf?=
 =?us-ascii?Q?U+cz7xwK3uEJA8Cz/AIqm+UNBAQpvyK47F3z3367spEcD72SK4KO47+tet8Z?=
 =?us-ascii?Q?oYy0bMFAsnnst0rt71LxOGUYsEM+BMs+wrUEj6XWKO/66ZTfi1BZtYCbEDR6?=
 =?us-ascii?Q?LeE9SUIXu+2Uj5LWsh6U+Mejb7YgVHHfWyw5yScFzJP5xCQ6+3ppfGv0lBDG?=
 =?us-ascii?Q?scbAdId5LC7qgFgaoyex1dlElMpTyr437ShcNN+7hipKKBulg/iYw8YmP0Q2?=
 =?us-ascii?Q?j5ke+h9M+r+7lKkekZWzh6MkeMxdI41MM4LMM7RJwDfyyEYfRwFXPCp48e7u?=
 =?us-ascii?Q?mtgN0SBpVM8Q74LfPuAeBe4p1d2B90rdkSQ5rDga9o4yxDN2NVOegq2i1RT6?=
 =?us-ascii?Q?2FdTMSzdJEslbS/qp3uu2eAQ6qqf2qAx99/jryh+lWYMSBHqFXJ4kTFNv/qT?=
 =?us-ascii?Q?P4AbbZeFhHvMCov6FbCQMJv992I4sofInCEyBWcTPyJ27NWi96L2qTK0RmTC?=
 =?us-ascii?Q?RugJ165GzuEjhUEVrRw5f8k37j8tDvrBLHP2HtbbgrwmZn3KAYkDRi1RuXMV?=
 =?us-ascii?Q?9Z3zQ3kXtrJLiajuRIyOBsYgEmxuekjeXjqTlcw2XJcR+sAOkjvdugrs/RDY?=
 =?us-ascii?Q?ieJMtjqMrDVfieZnaK2W4PzlKvFFGfKe0jOtmZUxMdOwsg0yyaRWeh/fEFF5?=
 =?us-ascii?Q?I12EGGW/9sfmPQ9k/fQzI6KM810t+uWTSf53MUq5tS1Dar/v9JIeAyZCL+55?=
 =?us-ascii?Q?3MkP+TksS8VuiBTNDawNDX6W8mvr/36RarbtwBL+SsogPHAs4Irv7WdzNSM2?=
 =?us-ascii?Q?f6g8KawVulcCqpPCBWZb1jd4uszJlkCu7RnrrwLhiSi4v82hEZtaShsIIk+P?=
 =?us-ascii?Q?msDY0PzBswwpQAkeByyzV5l5/BwB3iEtHYvnxi6KIiwf+UH0EDsD0Df5wCM9?=
 =?us-ascii?Q?Ua5wMQFrdZFRrp5HVdPHhMh5ohee5VmPsSCT42DW8sMQk88o1Pnnoe8NLrD6?=
 =?us-ascii?Q?Axa6n+H4xP1mHmqozXV+1F48wk3qKwqI3Dl6Zm3kO5+6SQtYrtM8tBHelxS8?=
 =?us-ascii?Q?Ttn342btO3HsqB7IfGSP/J3tLKFGXBpMPBr7NihTWtGAzMkW27MEnNEItG3M?=
 =?us-ascii?Q?iEBf77yZg6gS6BJ+ZHt9zAHPMqMFdaudYtn6zAQk2yQdzVfFTXxE9047ouxB?=
 =?us-ascii?Q?IEWzIdZTV7dpyz894X7vbjxND3lbVZbvcbwxXeOc8Sc9FJROpmTYG6SPNs99?=
 =?us-ascii?Q?1taUtAxekXyaG+wD45IAmiXiMy74JkHkbrzo5O2j5tVDxcQ5cdMZSeIxsU4x?=
 =?us-ascii?Q?RXm3Srqrm0NuejfbyLAetcE=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 
	DqJvyWqjliBtbxvphWemaGE+rPOjt5i6SFFCJ2gCjnpWyLiyF0JCdrS+ONLJNwpU6rCmWNFbN8d42sc7sbtfoHgU4dbrNm6/C9ZbgaaybAnN6m5hkMaHvGarnOyVHblic7FGnAWtomJdb3WN7H5bgz1RW0jqnchHDknK0bHuE6lIUG+rGtQ/h9JHYdkyiD5MTw2Ohn7Ak4ffFA9tpnKtHcJp6RbJDzM+v2tDA0tcuoGu+YqgXrEoUd1+SMHFcXzHNbFZKhWwYaJdJWkirvUlvySpEscLmb8oskxtyhdCx5tKNZ5f/375aCtBFpCGy4c17w7+2OShsn5qvazZLUOATJyGXEMEM9hbdQNYNR0OSKRX3xVvHQDb3OzcgdzCD1ZxOiY3TmUMq/zz9MRNOUsMYdn/Glcx6ya88BG/ZtkQsEiV+P8+yetyMOCpFk24q3ck0tcbQMrcK9rKvFiLUm91DuCUFEH1o6XXb0gE2UJLft/0ok5B6JOQHbUk7dEzev8fDGcJFcypj6dJZDavCYBX8ZJ6m8TWxYjIfPwaj/icmfGfyYAL1Pg5uYinSVq3h6TtgRnNSCEwmxxFVZdi4o/5qwDtoMeD3pWaiRZjOYtEwYQ=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 285781ec-f032-4d65-42ed-08dc713f3376
X-MS-Exchange-CrossTenant-AuthSource: PH8PR10MB6597.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 May 2024 22:19:04.1635
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: mVnf7t4XVU524dyztU/0fj8B2VGqPJLL3/L3z9wkLuCCN4MmyjBc4z1LB6J4mYld4Y4Pdf0SZfabpff7nCskcNgBhXg7SfAZLX6dHbxBIWk=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW5PR10MB5762
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.293,Aquarius:18.0.1039,Hydra:6.0.650,FMLib:17.11.176.26
 definitions=2024-05-10_16,2024-05-10_02,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 suspectscore=0 mlxscore=0
 mlxlogscore=999 spamscore=0 bulkscore=0 phishscore=0 malwarescore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2405010000
 definitions=main-2405100161
X-Proofpoint-GUID: gKH3L2PVAvJ8HdxrtZOX8h3-I8u8L3Qr
X-Proofpoint-ORIG-GUID: gKH3L2PVAvJ8HdxrtZOX8h3-I8u8L3Qr

From: Amir Goldstein <amir73il@gmail.com>

Call fsnotify_update_children_dentry_flags() to set PARENT_WATCHED flags
only when parent starts watching children.

When parent stops watching children, clear false positive PARENT_WATCHED
flags lazily in __fsnotify_parent() for each accessed child.

Suggested-by: Jan Kara <jack@suse.cz>
Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com>
---
 fs/notify/fsnotify.c             | 26 ++++++++++++++++++++------
 fs/notify/fsnotify.h             |  3 ++-
 fs/notify/mark.c                 | 32 +++++++++++++++++++++++++++++---
 include/linux/fsnotify_backend.h |  8 +++++---
 4 files changed, 56 insertions(+), 13 deletions(-)

diff --git a/fs/notify/fsnotify.c b/fs/notify/fsnotify.c
index 2fc105a72a8f6..86d332baaba21 100644
--- a/fs/notify/fsnotify.c
+++ b/fs/notify/fsnotify.c
@@ -103,17 +103,13 @@ void fsnotify_sb_delete(struct super_block *sb)
  * parent cares.  Thus when an event happens on a child it can quickly tell
  * if there is a need to find a parent and send the event to the parent.
  */
-void __fsnotify_update_child_dentry_flags(struct inode *inode)
+void fsnotify_update_children_dentry_flags(struct inode *inode, bool watched)
 {
 	struct dentry *alias;
-	int watched;
 
 	if (!S_ISDIR(inode->i_mode))
 		return;
 
-	/* determine if the children should tell inode about their events */
-	watched = fsnotify_inode_watches_children(inode);
-
 	spin_lock(&inode->i_lock);
 	/* run all of the dentries associated with this inode.  Since this is a
 	 * directory, there damn well better only be one item on this list */
@@ -140,6 +136,24 @@ void __fsnotify_update_child_dentry_flags(struct inode *inode)
 	spin_unlock(&inode->i_lock);
 }
 
+/*
+ * Lazily clear false positive PARENT_WATCHED flag for child whose parent had
+ * stopped watching children.
+ */
+static void fsnotify_update_child_dentry_flags(struct inode *inode,
+					       struct dentry *dentry)
+{
+	spin_lock(&dentry->d_lock);
+	/*
+	 * d_lock is a sufficient barrier to prevent observing a non-watched
+	 * parent state from before the fsnotify_update_children_dentry_flags()
+	 * or fsnotify_update_flags() call that had set PARENT_WATCHED.
+	 */
+	if (!fsnotify_inode_watches_children(inode))
+		dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
+	spin_unlock(&dentry->d_lock);
+}
+
 /* Are inode/sb/mount interested in parent and name info with this event? */
 static bool fsnotify_event_needs_parent(struct inode *inode, __u32 mnt_mask,
 					__u32 mask)
@@ -214,7 +228,7 @@ int __fsnotify_parent(struct dentry *dentry, __u32 mask, const void *data,
 	p_inode = parent->d_inode;
 	p_mask = fsnotify_inode_watches_children(p_inode);
 	if (unlikely(parent_watched && !p_mask))
-		__fsnotify_update_child_dentry_flags(p_inode);
+		fsnotify_update_child_dentry_flags(p_inode, dentry);
 
 	/*
 	 * Include parent/name in notification either if some notification
diff --git a/fs/notify/fsnotify.h b/fs/notify/fsnotify.h
index fde74eb333cc9..bce9be36d06b5 100644
--- a/fs/notify/fsnotify.h
+++ b/fs/notify/fsnotify.h
@@ -74,7 +74,8 @@ static inline void fsnotify_clear_marks_by_sb(struct super_block *sb)
  * update the dentry->d_flags of all of inode's children to indicate if inode cares
  * about events that happen to its children.
  */
-extern void __fsnotify_update_child_dentry_flags(struct inode *inode);
+extern void fsnotify_update_children_dentry_flags(struct inode *inode,
+						  bool watched);
 
 extern struct kmem_cache *fsnotify_mark_connector_cachep;
 
diff --git a/fs/notify/mark.c b/fs/notify/mark.c
index d6944ff86ffab..07cd66dc42fd6 100644
--- a/fs/notify/mark.c
+++ b/fs/notify/mark.c
@@ -176,6 +176,24 @@ static void *__fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
 	return fsnotify_update_iref(conn, want_iref);
 }
 
+static bool fsnotify_conn_watches_children(
+					struct fsnotify_mark_connector *conn)
+{
+	if (conn->type != FSNOTIFY_OBJ_TYPE_INODE)
+		return false;
+
+	return fsnotify_inode_watches_children(fsnotify_conn_inode(conn));
+}
+
+static void fsnotify_conn_set_children_dentry_flags(
+					struct fsnotify_mark_connector *conn)
+{
+	if (conn->type != FSNOTIFY_OBJ_TYPE_INODE)
+		return;
+
+	fsnotify_update_children_dentry_flags(fsnotify_conn_inode(conn), true);
+}
+
 /*
  * Calculate mask of events for a list of marks. The caller must make sure
  * connector and connector->obj cannot disappear under us.  Callers achieve
@@ -184,15 +202,23 @@ static void *__fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
  */
 void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
 {
+	bool update_children;
+
 	if (!conn)
 		return;
 
 	spin_lock(&conn->lock);
+	update_children = !fsnotify_conn_watches_children(conn);
 	__fsnotify_recalc_mask(conn);
+	update_children &= fsnotify_conn_watches_children(conn);
 	spin_unlock(&conn->lock);
-	if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
-		__fsnotify_update_child_dentry_flags(
-					fsnotify_conn_inode(conn));
+	/*
+	 * Set children's PARENT_WATCHED flags only if parent started watching.
+	 * When parent stops watching, we clear false positive PARENT_WATCHED
+	 * flags lazily in __fsnotify_parent().
+	 */
+	if (update_children)
+		fsnotify_conn_set_children_dentry_flags(conn);
 }
 
 /* Free all connectors queued for freeing once SRCU period ends */
diff --git a/include/linux/fsnotify_backend.h b/include/linux/fsnotify_backend.h
index 8f40c349b2283..59e6b8e98a4c1 100644
--- a/include/linux/fsnotify_backend.h
+++ b/include/linux/fsnotify_backend.h
@@ -563,12 +563,14 @@ static inline __u32 fsnotify_parent_needed_mask(__u32 mask)
 
 static inline int fsnotify_inode_watches_children(struct inode *inode)
 {
+	__u32 parent_mask = READ_ONCE(inode->i_fsnotify_mask);
+
 	/* FS_EVENT_ON_CHILD is set if the inode may care */
-	if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
+	if (!(parent_mask & FS_EVENT_ON_CHILD))
 		return 0;
 	/* this inode might care about child events, does it care about the
 	 * specific set of events that can happen on a child? */
-	return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
+	return parent_mask & FS_EVENTS_POSS_ON_CHILD;
 }
 
 /*
@@ -582,7 +584,7 @@ static inline void fsnotify_update_flags(struct dentry *dentry)
 	/*
 	 * Serialisation of setting PARENT_WATCHED on the dentries is provided
 	 * by d_lock. If inotify_inode_watched changes after we have taken
-	 * d_lock, the following __fsnotify_update_child_dentry_flags call will
+	 * d_lock, the following fsnotify_update_children_dentry_flags call will
 	 * find our entry, so it will spin until we complete here, and update
 	 * us with the new state.
 	 */
-- 
2.43.0