Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Imran Khan <imran.f.khan@oracle.com>
To:     tj@kernel.org, viro@zeniv.linux.org.uk, gregkh@linuxfoundation.org
Cc:     linux-kernel@vger.kernel.org
Subject: [PATCH v4 3/4] kernfs: Introduce interface to access global kernfs_open_file_mutex.
Date:   Thu, 19 May 2022 17:26:57 +1000
Message-Id: <20220519072658.736370-4-imran.f.khan@oracle.com>
In-Reply-To: <20220519072658.736370-1-imran.f.khan@oracle.com>
References: <20220519072658.736370-1-imran.f.khan@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?qAsLn5uftDdUhlrEI60f+ExfIKccIfEgATETmgym3GHc4/0miklP11u2rcKX?=
 =?us-ascii?Q?brc8zB3YuyqeasLjYNbRzuFub9t3ZsKTM5PHM4C9BRUa5K6DTyiaUj6KLY/4?=
 =?us-ascii?Q?kU7tcPyVB70MpcHOe2skd4gwJiHMfBkcSKNw4px0P84NPA+74v0wWvQFFIA/?=
 =?us-ascii?Q?Kd/Z30JqRGu6uBJoS59d0ztYKOR3kzHqFuOpSeLiU04rtsDr1xAHo2iv3oHR?=
 =?us-ascii?Q?b4r2SlpCDJH7uAEHNH1EZljJV6NgiXHwItQ2Oq3yAMa8FP1/A87YwuwRl2Aq?=
 =?us-ascii?Q?wCoirVCtTmqYE+zthXl8dl1aCKius/mNyI7Id/EVh8XYGVYh5mHycYA0610U?=
 =?us-ascii?Q?ztR9kzj5GVLfk9B7NubP3/Jcr+XwVY2/sPHNbi0ANvwKGSMkEPUKhzWQRZoz?=
 =?us-ascii?Q?SiyI9mwWJzI5LeCSIvOqLFP03PDVq3z+oC0ebLFfoFDR5Jc8WRMHOjYTrLhq?=
 =?us-ascii?Q?cvAzHvTU5in+NzOzmaP+yBmVzT/OPsBXClOpMtZnsi4cwmkGPXeMbiHJtCW1?=
 =?us-ascii?Q?MMixx4My2fToiMVoNRuSCSVq4oZJVdLY58faJxZkYTIqu/SaTwdoEMJA0RuU?=
 =?us-ascii?Q?GKG7AV/ekgNWZHi1yVwA+YuPwSt1YSvB4ymAFLVGdaZmN9yYs0FmduuHxvtY?=
 =?us-ascii?Q?ZNRzkXL8O8kmenmEaF1Wc4fN6WrPaLMMuXvrRmoWC/MpchyqCY36meTdBjsf?=
 =?us-ascii?Q?2XRP9/80aMAieIEi2eJUKGXJA4BeS1WjpN3Y/xbPppSuR48BUvQfFbqzxSEM?=
 =?us-ascii?Q?hVcp9FGFQho8zeBlLtWOnj9N/Z/yQsje4HL8TuglS7pJzOzmMKRfTNKVOsUN?=
 =?us-ascii?Q?enYwS7AOaiAXPMgIXVwSDlyaItf8Nir5EpYacMbNBDiICEvz7fu3BxqekXU9?=
 =?us-ascii?Q?3XXLTVFGObhwn+uwkzcjYTRZ7V3kdl1mdqUICCnftXIATgNIuh04JfvJS96v?=
 =?us-ascii?Q?jlK9XYLbTQ4haSxyaZe89CtKbhO6mAPbk6qQjsuLvoxifRUpINfrQzyaihuc?=
 =?us-ascii?Q?lAq1iu4NQSJi1BtE1xp0OJeqlPOFumf+FKEg/owmLKFq+pFyGyJaSQsHVGrA?=
 =?us-ascii?Q?IcQngnGGhT8wBYWWV79UEI5ozlW3NxEAu7mMPgd0P7J5qnyNMdyqHEOiKNZX?=
 =?us-ascii?Q?lQGoKlg/7gRP+Cjev91GQMYK/wWjmbOYglsP/3DJl1qm0EqUTIaGKt+8oiOQ?=
 =?us-ascii?Q?5b3mCPUm8nnAO9Hgu2U4U0+Oz0LOxstJD1aVNmXlF1k6BNptvR6nMC1LsXtW?=
 =?us-ascii?Q?9x7w//lV6emVLo4UOCoJpIj8QTiZnttWwz1vI90BsIxqOrPD2NJEGJS/r1Gv?=
 =?us-ascii?Q?0vfYJpsgEREw3SDxzn6WQUzzJlCEg+S5luwKlCicKlodK6epAVpGiViOkTDH?=
 =?us-ascii?Q?EjVyc7+enFTuWkDmrJzNUrlGAvnzhTw8jXcfa8PMmiGyxWu8me+D8CpXqaUg?=
 =?us-ascii?Q?mGCIC432K/1ngef0MMGh4EIoueD7qHI1Tn2uJSg9l3k81W1Z1XGWmHrkD+4Z?=
 =?us-ascii?Q?VpzCXwe8KCQ19Wk/lQ1uprq5IdyShN+RAJo7Ao+ZCr2Cvh4PXk18W4izmUsR?=
 =?us-ascii?Q?MGObaBMEOJTDD2nVdboXI0TrWYZi1mRLaQKv5oZFBaq88JbsdH8tbodbp7Qp?=
 =?us-ascii?Q?tzB7U843CB0vs3qx90tFSb1ZR1mclYXr+GzEYsKnIX0N9rs9vNoSmQ4arzCC?=
 =?us-ascii?Q?kheyeCJfa8TwD9DBFFy9BKOHnoTdLAF96DIWsNPyZKFoEVV0WrZPmwPBPGQS?=
 =?us-ascii?Q?x8o4wCGISq7IL0qYehXOF26VxBMBc1w=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5f9c0ca6-d16c-49f7-3050-08da39690012
X-MS-Exchange-CrossTenant-AuthSource: CO1PR10MB4468.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 May 2022 07:27:16.3294
 (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: ZEOj36HBFjRMLWLbI/h0JuFQ8P8RJ3T1DDrxmqbh1MlqYiEBTcih/jPJdiThYZss90xptJamBv5l4C74hxeb5Q==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1001MB2154
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.486,18.0.874
 definitions=2022-05-19_01:2022-05-17,2022-05-19 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 mlxscore=0 suspectscore=0
 phishscore=0 bulkscore=0 adultscore=0 mlxlogscore=999 malwarescore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2202240000
 definitions=main-2205190045
X-Proofpoint-GUID: V4Xh8p_4xqYfEW2z9YJvRNTf8EBbxT1-
X-Proofpoint-ORIG-GUID: V4Xh8p_4xqYfEW2z9YJvRNTf8EBbxT1-
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

This allows to change underlying mutex locking, without needing to change
the users of the lock. For example next patch modifies this interface to
use hashed mutexes in place of a single global kernfs_open_file_mutex.

Signed-off-by: Imran Khan <imran.f.khan@oracle.com>
Acked-by: Tejun Heo <tj@kernel.org>
---
 fs/kernfs/file.c | 72 +++++++++++++++++++++++++++++++-----------------
 1 file changed, 46 insertions(+), 26 deletions(-)

diff --git a/fs/kernfs/file.c b/fs/kernfs/file.c
index 3f883601c5ec..87ea8127c98c 100644
--- a/fs/kernfs/file.c
+++ b/fs/kernfs/file.c
@@ -49,6 +49,22 @@ struct kernfs_open_node {
 
 static LLIST_HEAD(kernfs_notify_list);
 
+static inline struct mutex *kernfs_open_file_mutex_ptr(struct kernfs_node *kn)
+{
+	return &kernfs_open_file_mutex;
+}
+
+static inline struct mutex *kernfs_open_file_mutex_lock(struct kernfs_node *kn)
+{
+	struct mutex *lock;
+
+	lock = kernfs_open_file_mutex_ptr(kn);
+
+	mutex_lock(lock);
+
+	return lock;
+}
+
 /**
  * kernfs_deref_open_node - Get kernfs_open_node corresponding to @kn.
  *
@@ -80,21 +96,21 @@ kernfs_deref_open_node(struct kernfs_open_file *of, struct kernfs_node *kn)
  * @kn: target kernfs_node.
  *
  * Fetch and return ->attr.open of @kn when caller(writer) holds
- * kernfs_open_file_mutex.
+ * kernfs_open_file_mutex_ptr(kn).
  *
- * Update of ->attr.open happens under kernfs_open_file_mutex. So as long as
- * the current updater (caller) is holding this mutex, other updaters will not
- * be able to change ->attr.open and this means that we can safely deref
- * ->attr.open outside RCU read-side critical section.
+ * Update of ->attr.open happens under kernfs_open_file_mutex_ptr(kn). So as
+ * long as the current updater (caller) is holding this mutex, other updaters
+ * will not be able to change ->attr.open and this means that we can safely
+ * deref ->attr.open outside RCU read-side critical section.
  *
  * This should ONLY be used by updaters of ->attr.open and caller needs to make
- * sure that kernfs_open_file_mutex is held.
+ * sure that kernfs_open_file_mutex_ptr(kn) is held.
  */
 static struct kernfs_open_node *
 kernfs_deref_open_node_protected(struct kernfs_node *kn)
 {
 	return rcu_dereference_protected(kn->attr.open,
-				lockdep_is_held(&kernfs_open_file_mutex));
+			lockdep_is_held(kernfs_open_file_mutex_ptr(kn)));
 }
 
 /**
@@ -103,21 +119,21 @@ kernfs_deref_open_node_protected(struct kernfs_node *kn)
  * @kn: target kernfs_node.
  *
  * Fetch and return ->attr.open of @kn when caller(reader) holds
- * kernfs_open_file_mutex.
+ * kernfs_open_file_mutex_ptr(kn).
  *
- * Update of ->attr.open happens under kernfs_open_file_mutex. So as long as
- * the current reader (caller) is holding this mutex, updaters will not be
- * able to change ->attr.open and this means that we can safely deref
+ * Update of ->attr.open happens under kernfs_open_file_mutex_ptr(kn). So as
+ * long as the current reader (caller) is holding this mutex, updaters will
+ * not be able to change ->attr.open and this means that we can safely deref
  * ->attr.open outside RCU read-side critical section.
  *
  * This should ONLY be used by readers of ->attr.open and caller needs to make
- * sure that kernfs_open_file_mutex is held.
+ * sure that kernfs_open_file_mutex_ptr(kn) is held.
  */
 static struct kernfs_open_node *
 kernfs_check_open_node_protected(struct kernfs_node *kn)
 {
 	return rcu_dereference_check(kn->attr.open,
-				      lockdep_is_held(&kernfs_open_file_mutex));
+			lockdep_is_held(kernfs_open_file_mutex_ptr(kn)));
 }
 
 static struct kernfs_open_file *kernfs_of(struct file *file)
@@ -600,19 +616,20 @@ static int kernfs_get_open_node(struct kernfs_node *kn,
 				struct kernfs_open_file *of)
 {
 	struct kernfs_open_node *on, *new_on = NULL;
+	struct mutex *mutex = NULL;
 
-	mutex_lock(&kernfs_open_file_mutex);
+	mutex = kernfs_open_file_mutex_lock(kn);
 	on = kernfs_deref_open_node_protected(kn);
 
 	if (on) {
 		list_add_tail(&of->list, &on->files);
-		mutex_unlock(&kernfs_open_file_mutex);
+		mutex_unlock(mutex);
 		return 0;
 	} else {
 		/* not there, initialize a new one */
 		new_on = kmalloc(sizeof(*new_on), GFP_KERNEL);
 		if (!new_on) {
-			mutex_unlock(&kernfs_open_file_mutex);
+			mutex_unlock(mutex);
 			return -ENOMEM;
 		}
 		atomic_set(&new_on->event, 1);
@@ -621,7 +638,7 @@ static int kernfs_get_open_node(struct kernfs_node *kn,
 		list_add_tail(&of->list, &new_on->files);
 		rcu_assign_pointer(kn->attr.open, new_on);
 	}
-	mutex_unlock(&kernfs_open_file_mutex);
+	mutex_unlock(mutex);
 
 	return 0;
 }
@@ -643,12 +660,13 @@ static void kernfs_unlink_open_file(struct kernfs_node *kn,
 				 struct kernfs_open_file *of)
 {
 	struct kernfs_open_node *on;
+	struct mutex *mutex = NULL;
 
-	mutex_lock(&kernfs_open_file_mutex);
+	mutex = kernfs_open_file_mutex_lock(kn);
 
 	on = kernfs_deref_open_node_protected(kn);
 	if (!on) {
-		mutex_unlock(&kernfs_open_file_mutex);
+		mutex_unlock(mutex);
 		return;
 	}
 
@@ -660,7 +678,7 @@ static void kernfs_unlink_open_file(struct kernfs_node *kn,
 		kfree_rcu(on, rcu_head);
 	}
 
-	mutex_unlock(&kernfs_open_file_mutex);
+	mutex_unlock(mutex);
 }
 
 static int kernfs_fop_open(struct inode *inode, struct file *file)
@@ -802,7 +820,7 @@ static void kernfs_release_file(struct kernfs_node *kn,
 	 * here because drain path may be called from places which can
 	 * cause circular dependency.
 	 */
-	lockdep_assert_held(&kernfs_open_file_mutex);
+	lockdep_assert_held(kernfs_open_file_mutex_ptr(kn));
 
 	if (!of->released) {
 		/*
@@ -819,11 +837,12 @@ static int kernfs_fop_release(struct inode *inode, struct file *filp)
 {
 	struct kernfs_node *kn = inode->i_private;
 	struct kernfs_open_file *of = kernfs_of(filp);
+	struct mutex *mutex = NULL;
 
 	if (kn->flags & KERNFS_HAS_RELEASE) {
-		mutex_lock(&kernfs_open_file_mutex);
+		mutex = kernfs_open_file_mutex_lock(kn);
 		kernfs_release_file(kn, of);
-		mutex_unlock(&kernfs_open_file_mutex);
+		mutex_unlock(mutex);
 	}
 
 	kernfs_unlink_open_file(kn, of);
@@ -838,6 +857,7 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 {
 	struct kernfs_open_node *on;
 	struct kernfs_open_file *of;
+	struct mutex *mutex = NULL;
 
 	if (!(kn->flags & (KERNFS_HAS_MMAP | KERNFS_HAS_RELEASE)))
 		return;
@@ -853,10 +873,10 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 	if (!rcu_access_pointer(kn->attr.open))
 		return;
 
-	mutex_lock(&kernfs_open_file_mutex);
+	mutex = kernfs_open_file_mutex_lock(kn);
 	on = kernfs_check_open_node_protected(kn);
 	if (!on) {
-		mutex_unlock(&kernfs_open_file_mutex);
+		mutex_unlock(mutex);
 		return;
 	}
 
@@ -870,7 +890,7 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 			kernfs_release_file(kn, of);
 	}
 
-	mutex_unlock(&kernfs_open_file_mutex);
+	mutex_unlock(mutex);
 }
 
 /*
-- 
2.30.2