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, gregkh@linuxfoundation.org, viro@zeniv.linux.org.uk
Cc:     linux-kernel@vger.kernel.org
Subject: [PATCH v3 3/4] kernfs: Introduce interface to access global kernfs_open_file_mutex.
Date:   Wed, 11 May 2022 19:51:56 +1000
Message-Id: <20220511095157.478522-4-imran.f.khan@oracle.com>
In-Reply-To: <20220511095157.478522-1-imran.f.khan@oracle.com>
References: <20220511095157.478522-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?8SDNBSSXSYjDHkO/GGTgSJucS8PxB+c6hsA91MHwVdoGzkNl0+Xeax8m7Dq2?=
 =?us-ascii?Q?Z2WP2odQslLiXt75LrHU7XS5DNHkIsq1bBIFOhiBzMVI9eL8tPuYAUYpMmJb?=
 =?us-ascii?Q?hhwvMl2FY6Ri6d8crEWf5n9ERs5TYn8dtn/5BtSesN+K7nUALmZHn1GAwO6l?=
 =?us-ascii?Q?qh3epF5Dbz6oFDRBXM8Qf6Za2xaRV4Tygu+rjqqjiLc39dC+5RgtybXNS7jk?=
 =?us-ascii?Q?0cCF0ald3ZRwtFS6HCa5CW0mJBynWkRDCBtU/TrbADQjLksi6L/RuMEKOqff?=
 =?us-ascii?Q?O9cRpl1B2Pffp3KNpo3HzjrctltjrgTFkreZ5HLpRGsQ3JPs5ZER4wZTUtij?=
 =?us-ascii?Q?YmcGujSAiBLwk2R5QzrVSdzoCfyNU5iQMx2oI27C0v+i7CflQrozBG06aiDl?=
 =?us-ascii?Q?FuYLsBPOkzvpPXFdKT55OTxf8Sv+NNWCbGQIl5NTWbxk2bey9JgDpculluv2?=
 =?us-ascii?Q?Zqsz3k/JCFe/pClCLrr5ZOZ5wwu/HcbDOC0L9KS2AZj9UAA6WYgXkkyaylfY?=
 =?us-ascii?Q?o+fYgkzZpJHl518SKLbkpp6o+uKTJanA9niLa6nT8DfrekjQTxOJWldE+Jyr?=
 =?us-ascii?Q?LHp2/khuFrn3ZpA1Lf5N48AM66ovYNDuWJjl8TuJw+E0MSqqZNRpr+D4/9AS?=
 =?us-ascii?Q?VY1i5MFzSel76mSHUTGRgYdGJc7X+Dfpmj8uHTU+xIdor0m7yqdYEeAZYXA+?=
 =?us-ascii?Q?OwriOFtZgYvU8WpoYq47YfcwKgaZ7UPjzqrrVhm78cVazUQXwzKRAHJ3llik?=
 =?us-ascii?Q?AwWo35PCgXyhTFbNPS0OOYTHuEwVTdByfy4QXiN83TwrvNSnaIkO1zRlygRD?=
 =?us-ascii?Q?hSJJRl84DrHHMqZgfOrhTpkpVP7+7lyLvE/zy6jQ1rpypZTfjybRu816D61v?=
 =?us-ascii?Q?onx/hDWJsAEgv775F2ZNxsNpRE+LaQAaRe7bdrY6VdjdhZ0accsCxhX8KjQq?=
 =?us-ascii?Q?YNxUKuwD6KkxzdfR0sUdjAYxCItxLl+Arv99UI3VKFOo/3s6Gk6V9s6arUVx?=
 =?us-ascii?Q?R6yx81oo/vjxLYdb5rQQhKIRPjD4IAFjNUPLXmNo3czEfePSa+M5N8Lynuuj?=
 =?us-ascii?Q?k+mjN0dTJfYHWm8Y1+GH5MbV0LK/Tl2Tup1/Nm8WY6o8/tkUC0f5Hk0GjTJP?=
 =?us-ascii?Q?PimKbc58ULQhMGFzLsfltBz3zMwPbmzvYV/fPHNw0RwgVVviQi1dhCjnW4Wt?=
 =?us-ascii?Q?XSHmDef+btWWHYbaAHf3cbJMEcRoxgyCqSXIgV3BcP1PyPFpacMPxLG2mZbg?=
 =?us-ascii?Q?YCLeATp3WHcKtba6uQfIrLiD5MOTQ2b6ImquHGFDK+88uXABP1zUgcIaVN/4?=
 =?us-ascii?Q?7uOAAOvzHO0bUYhgge+82+qNp53QxgEhPbhMu9yqxh5FeSpDuLNT7RhTQUa2?=
 =?us-ascii?Q?IfiBEkuzlyKrX8/hy3c8rMkP/G1vMFb1gkOza9TjG2wwagOxErh9535J18GE?=
 =?us-ascii?Q?Ux+nzOpERgJVTM6sgA4Wu4+t3NPJSPd/1L8wDwagdLfdBQwfdO6NOsxZrLNb?=
 =?us-ascii?Q?ceknExD/UsVCKc84lOSrmEWF/5rh+BC7Lmt9CemXNMZZYmdDxajhNqpLbYRm?=
 =?us-ascii?Q?enJeKV77wHe1PaqUhhvp1GSvQFO20Fb2LiZmV5e1QoETDQsoFutoa6ipF/Fh?=
 =?us-ascii?Q?Jwxvi1zoda9oFx4Kl3hSI/LAhVcqotTZ46mGgban+PCQjVkIJ0bP6hi5dZ1r?=
 =?us-ascii?Q?Zlix5UpHZZBzJw2R9aIXRsGrS+Lr5Q6fcW8ooGObCxI7tmoGejMgYT8FQtgL?=
 =?us-ascii?Q?e2KV+AJLGj4o9r+62s2E3k6vVSjZ2gc=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3f65c4cf-ba66-4bc0-a147-08da3333eddb
X-MS-Exchange-CrossTenant-AuthSource: CO1PR10MB4468.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 May 2022 09:52:15.6412
 (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: KlNX+f0ARvscWpaXNFNIGOmItcOZDEausDQuY6l3OHCHcWEfG60MGm/X8ImmFvijk4uiaifGat40BXW7LtPctw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR10MB6178
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.486,18.0.858
 definitions=2022-05-11_03:2022-05-09,2022-05-11 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 phishscore=0
 adultscore=0 bulkscore=0 malwarescore=0 mlxscore=0 mlxlogscore=963
 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2202240000 definitions=main-2205110044
X-Proofpoint-GUID: Zu7m2nVPGmw5G1uN9f4w222JerbGIyX0
X-Proofpoint-ORIG-GUID: Zu7m2nVPGmw5G1uN9f4w222JerbGIyX0
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,SPF_HELO_NONE,
        SPF_NONE,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED 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 | 50 +++++++++++++++++++++++++++++++++---------------
 1 file changed, 35 insertions(+), 15 deletions(-)

diff --git a/fs/kernfs/file.c b/fs/kernfs/file.c
index a8d8a9114b51..9000c85ce1e1 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;
+}
+
 /*
  * Raw deref RCU protected kn->attr.open.
  * If both @of->list and @kn->attr.open->files are non empty, we can safely
@@ -79,7 +95,7 @@ kernfs_deref_on_raw(struct kernfs_open_file *of, struct kernfs_node *kn)
 static struct kernfs_open_node *kernfs_deref_on_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)));
 }
 
 /*
@@ -90,7 +106,7 @@ static struct kernfs_open_node *kernfs_deref_on_protected(struct kernfs_node *kn
 static struct kernfs_open_node *kernfs_check_on_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)
@@ -569,19 +585,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_on_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);
@@ -590,7 +607,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;
 }
@@ -612,12 +629,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_on_protected(kn);
 	if (!on) {
-		mutex_unlock(&kernfs_open_file_mutex);
+		mutex_unlock(mutex);
 		return;
 	}
 
@@ -629,7 +647,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)
@@ -771,7 +789,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) {
 		/*
@@ -788,11 +806,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);
@@ -807,6 +826,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;
@@ -822,10 +842,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_on_protected(kn);
 	if (!on) {
-		mutex_unlock(&kernfs_open_file_mutex);
+		mutex_unlock(mutex);
 		return;
 	}
 
@@ -839,7 +859,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