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 v5 4/4] kernfs: Replace global kernfs_open_file_mutex with hashed mutexes.
Date:   Tue, 14 Jun 2022 12:08:40 +1000
Message-Id: <20220614020840.546013-5-imran.f.khan@oracle.com>
In-Reply-To: <20220614020840.546013-1-imran.f.khan@oracle.com>
References: <20220614020840.546013-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?jYlDP3DfT96z4Khij80gGog6f+SLZJwYtZqTB1LJLRRBf7phNJZc6Bsy6CQp?=
 =?us-ascii?Q?L79F2J0RZKue+JA+ZL08oAE6CpTmtMvJ9w0Bh5B56Fv+T1MsQM9qUiv79sD9?=
 =?us-ascii?Q?nVJtawBDFbKfGMSkYxjwSlGo/1jkBQE741bqhYzCTFPPJC/8L1fp7xG1ybj0?=
 =?us-ascii?Q?sTCF5wYo6+Md5jCBVNo4BzBkEnqS/AEOjloejb8up3928xOJbogABUUDsqqP?=
 =?us-ascii?Q?ccsJJ1i2c0t2bFt8P35wZq2wCgVN3QZxAPrG2xRPABpdEFkz7rhYDjeDfX2O?=
 =?us-ascii?Q?Fqwyb0ELtxKriyyIFBC/TsmhsJWDx1YPEQbcc2SVWBxMt2+8eACK2c/RfBFc?=
 =?us-ascii?Q?AoWeAxopl8mhNGhtrO9Bt7nl4w51RUIacpU0Qah/fTtK5scLQ0tnAxCiJ+dB?=
 =?us-ascii?Q?+svrljxTq7VflY8h/VTnjCE6GRwe2VlJ2tvEafCjAYFs5l9RyOjRxmtcU9Dw?=
 =?us-ascii?Q?n7Ewhxe0PLf2Mkp2l5XiZcFZwt0aacZMX00nC/LEKpNIQzsT1+PByPEVBCJi?=
 =?us-ascii?Q?RUrLp9QMR/i0iz2r70PGNb0Av1KYtJFHmmBEFyYWqpw/vP0xgFAl5lIDbsCB?=
 =?us-ascii?Q?D+Tufo1iHEX3MwsqAEU9zi5tsIM8ybqpUBi9UeAAw6DeoesnTqwVJMK2wWmX?=
 =?us-ascii?Q?LP2qm9ASt4JEdmmLA2PRxOrKnEEq5x26LMK5X3b+u/XU5TnI5sS+j0FG7cAF?=
 =?us-ascii?Q?e+tbVUB5Jq+6R/rErtrDrn5qF3HKXVQBwIywhNNhQ6VVpRWZ/Nikyds2zI/O?=
 =?us-ascii?Q?j4YBZZdaBuIeVz2C0KbLMfUIjlu4BpEBhF//G6PdhzXBlGRfigl2Oe0/dvIv?=
 =?us-ascii?Q?q6ul3kHbIuzSXG2D5QGRo84jSJO3fPYwk9b5fi0kZnz3ljda4jCwvOZge+Dx?=
 =?us-ascii?Q?IZWFWF5xoHxt1pAi2OQaFaVHt2a2XhYiMJxtbLwy0OZdkaDoPYJgHkVdda66?=
 =?us-ascii?Q?oBUwtQ2tQAGMxFIikYvkma+stVI8TC42I+eNj2IZ79J0rcbBxnXc1+7sB+tA?=
 =?us-ascii?Q?hoUig/9Crcc4c0wRoiqwZrMhdaR5IIaZkRvBDE8yasfVm2Sy3myQAhN7pgY+?=
 =?us-ascii?Q?6deNZeIJMrljZGoKfuNV4sOXqdn+2y9AJwXJekaHjN1J3OD3LaUzjkdWbW99?=
 =?us-ascii?Q?GnR5yblKS6RcyjV6WgsOteIUBQ07of4x5ozoXhuMWXpyP8JjV0pgFUx7sbjf?=
 =?us-ascii?Q?a/m9XjhnGEQRUdhNIJMqNWPTw+qJIexGxjrkXXQXbyFSyfDI0iN6sjjKsjpj?=
 =?us-ascii?Q?iFw7ouUDBbUpJxrFA1XhRwpDiEdYH2gm5duFj7NYb6rJ9YGyTcxZW0hy9yuk?=
 =?us-ascii?Q?8itzIzYioaH4VjvYE92+B6K9h1SPVfrrI04ncFpqPuPn9FTbxMnG/Y4ptKSL?=
 =?us-ascii?Q?j6kQY9ja1CNNDbgVpVxt51M6CaxHvRN5pxjUsa3Pg/vhU54Im6OjbRJ4Ym4O?=
 =?us-ascii?Q?ibDHaovyLtHmAgpID5ylII9CN3DabjjJhCjPZy7Z8v3/a/paAdNXMAoAgi1F?=
 =?us-ascii?Q?g0w36y2pD26xZkQ8MPHykAYObnjotPAIubhJZ2Hu0+doN+DZhGSqJIaV6PRz?=
 =?us-ascii?Q?vgstmNjNCdHx2GLyZaZhYGrjWhuvtUWHud5JcvPOB9Cm/nN2XPjBFvBXnacP?=
 =?us-ascii?Q?p8pX5teu2MUMqBowbog1N+oNYosjWGJRnmbLZ+gXGAFxBHpieC4dtwup5X5z?=
 =?us-ascii?Q?dnra0r3yYXpgYLgQpz8QQNPCst5yo3wp3MY3EqgGfRCxiOVQz1EqTc3Ogo7l?=
 =?us-ascii?Q?8zniLXRkC+vsnzbRbhcCLvzEjLOpiIY=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4725fbd5-8e5c-4747-8c49-08da4daad7d5
X-MS-Exchange-CrossTenant-AuthSource: CO1PR10MB4468.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Jun 2022 02:08:58.8628
 (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: 3zHCgTZKlVllN+BLGgybfuv9hI9DzUQ+qYsNQbT4XOfbem2c5kBd+hlaf67rGtGMOStcq83W/AlvLqEu0u3Zfw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR1001MB2398
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.517,18.0.874
 definitions=2022-06-14_01:2022-06-13,2022-06-13 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 mlxscore=0 mlxlogscore=999
 malwarescore=0 phishscore=0 spamscore=0 suspectscore=0 bulkscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2204290000
 definitions=main-2206140007
X-Proofpoint-ORIG-GUID: akbrqYTuX3GBa3-z9UEEixC4_VbDObei
X-Proofpoint-GUID: akbrqYTuX3GBa3-z9UEEixC4_VbDObei
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

In current kernfs design a single mutex, kernfs_open_file_mutex, protects
the list of kernfs_open_file instances corresponding to a sysfs attribute.
So even if different tasks are opening or closing different sysfs files
they can contend on osq_lock of this mutex. The contention is more apparent
in large scale systems with few hundred CPUs where most of the CPUs have
running tasks that are opening, accessing or closing sysfs files at any
point of time.

Using hashed mutexes in place of a single global mutex, can significantly
reduce contention around global mutex and hence can provide better
scalability. Moreover as these hashed mutexes are not part of kernfs_node
objects we will not see any singnificant change in memory utilization of
kernfs based file systems like sysfs, cgroupfs etc.

Modify interface introduced in previous patch to make use of hashed
mutexes. Use kernfs_node address as hashing key.

Signed-off-by: Imran Khan <imran.f.khan@oracle.com>
Acked-by: Tejun Heo <tj@kernel.org>
---
 fs/kernfs/file.c            | 17 ++---------
 fs/kernfs/kernfs-internal.h |  4 +++
 fs/kernfs/mount.c           | 19 +++++++++++++
 include/linux/kernfs.h      | 57 +++++++++++++++++++++++++++++++++++++
 4 files changed, 83 insertions(+), 14 deletions(-)

diff --git a/fs/kernfs/file.c b/fs/kernfs/file.c
index 205b5c71f30cb..d821c20c59eaf 100644
--- a/fs/kernfs/file.c
+++ b/fs/kernfs/file.c
@@ -18,19 +18,6 @@
 
 #include "kernfs-internal.h"
 
-/*
- * There's one kernfs_open_file for each open file and one kernfs_open_node
- * for each kernfs_node with one or more open files.
- *
- * kernfs_node->attr.open points to kernfs_open_node.  attr.open is
- * RCU protected.
- *
- * filp->private_data points to seq_file whose ->private points to
- * kernfs_open_file.  kernfs_open_files are chained at
- * kernfs_open_node->files, which is protected by kernfs_open_file_mutex.
- */
-static DEFINE_MUTEX(kernfs_open_file_mutex);
-
 struct kernfs_open_node {
 	struct rcu_head		rcu_head;
 	atomic_t		event;
@@ -51,7 +38,9 @@ static LLIST_HEAD(kernfs_notify_list);
 
 static inline struct mutex *kernfs_open_file_mutex_ptr(struct kernfs_node *kn)
 {
-	return &kernfs_open_file_mutex;
+	int idx = hash_ptr(kn, NR_KERNFS_LOCK_BITS);
+
+	return &kernfs_locks->open_file_mutex[idx];
 }
 
 static inline struct mutex *kernfs_open_file_mutex_lock(struct kernfs_node *kn)
diff --git a/fs/kernfs/kernfs-internal.h b/fs/kernfs/kernfs-internal.h
index eeaa779b929c7..3ae214d02d441 100644
--- a/fs/kernfs/kernfs-internal.h
+++ b/fs/kernfs/kernfs-internal.h
@@ -164,4 +164,8 @@ void kernfs_drain_open_files(struct kernfs_node *kn);
  */
 extern const struct inode_operations kernfs_symlink_iops;
 
+/*
+ * kernfs locks
+ */
+extern struct kernfs_global_locks *kernfs_locks;
 #endif	/* __KERNFS_INTERNAL_H */
diff --git a/fs/kernfs/mount.c b/fs/kernfs/mount.c
index cfa79715fc1a7..d0859f72d2d64 100644
--- a/fs/kernfs/mount.c
+++ b/fs/kernfs/mount.c
@@ -20,6 +20,7 @@
 #include "kernfs-internal.h"
 
 struct kmem_cache *kernfs_node_cache, *kernfs_iattrs_cache;
+struct kernfs_global_locks *kernfs_locks;
 
 static int kernfs_sop_show_options(struct seq_file *sf, struct dentry *dentry)
 {
@@ -387,6 +388,22 @@ void kernfs_kill_sb(struct super_block *sb)
 	kfree(info);
 }
 
+static void __init kernfs_mutex_init(void)
+{
+	int count;
+
+	for (count = 0; count < NR_KERNFS_LOCKS; count++)
+		mutex_init(&kernfs_locks->open_file_mutex[count]);
+}
+
+static void __init kernfs_lock_init(void)
+{
+	kernfs_locks = kmalloc(sizeof(struct kernfs_global_locks), GFP_KERNEL);
+	WARN_ON(!kernfs_locks);
+
+	kernfs_mutex_init();
+}
+
 void __init kernfs_init(void)
 {
 	kernfs_node_cache = kmem_cache_create("kernfs_node_cache",
@@ -397,4 +414,6 @@ void __init kernfs_init(void)
 	kernfs_iattrs_cache  = kmem_cache_create("kernfs_iattrs_cache",
 					      sizeof(struct kernfs_iattrs),
 					      0, SLAB_PANIC, NULL);
+
+	kernfs_lock_init();
 }
diff --git a/include/linux/kernfs.h b/include/linux/kernfs.h
index 2dd9c8df0f4f6..13e703f615f79 100644
--- a/include/linux/kernfs.h
+++ b/include/linux/kernfs.h
@@ -18,6 +18,7 @@
 #include <linux/uidgid.h>
 #include <linux/wait.h>
 #include <linux/rwsem.h>
+#include <linux/cache.h>
 
 struct file;
 struct dentry;
@@ -34,6 +35,62 @@ struct kernfs_fs_context;
 struct kernfs_open_node;
 struct kernfs_iattrs;
 
+/*
+ * NR_KERNFS_LOCK_BITS determines size (NR_KERNFS_LOCKS) of hash
+ * table of locks.
+ * Having a small hash table would impact scalability, since
+ * more and more kernfs_node objects will end up using same lock
+ * and having a very large hash table would waste memory.
+ *
+ * At the moment size of hash table of locks is being set based on
+ * the number of CPUs as follows:
+ *
+ * NR_CPU      NR_KERNFS_LOCK_BITS      NR_KERNFS_LOCKS
+ *   1                  1                       2
+ *  2-3                 2                       4
+ *  4-7                 4                       16
+ *  8-15                6                       64
+ *  16-31               8                       256
+ *  32 and more         10                      1024
+ *
+ * The above relation between NR_CPU and number of locks is based
+ * on some internal experimentation which involved booting qemu
+ * with different values of smp, performing some sysfs operations
+ * on all CPUs and observing how increase in number of locks impacts
+ * completion time of these sysfs operations on each CPU.
+ */
+#ifdef CONFIG_SMP
+#define NR_KERNFS_LOCK_BITS (2 * (ilog2(NR_CPUS < 32 ? NR_CPUS : 32)))
+#else
+#define NR_KERNFS_LOCK_BITS     1
+#endif
+
+#define NR_KERNFS_LOCKS     (1 << NR_KERNFS_LOCK_BITS)
+
+/*
+ * There's one kernfs_open_file for each open file and one kernfs_open_node
+ * for each kernfs_node with one or more open files.
+ *
+ * filp->private_data points to seq_file whose ->private points to
+ * kernfs_open_file.
+ *
+ * kernfs_open_files are chained at kernfs_open_node->files, which is
+ * protected by kernfs_global_locks.open_file_mutex[i].
+ *
+ * To reduce possible contention in sysfs access, arising due to single
+ * locks, use an array of locks (e.g. open_file_mutex) and use kernfs_node
+ * object address as hash keys to get the index of these locks.
+ *
+ * Hashed mutexes are safe to use here because operations using these don't
+ * rely on global exclusion.
+ *
+ * In future we intend to replace other global locks with hashed ones as well.
+ * kernfs_global_locks acts as a holder for all such hash tables.
+ */
+struct kernfs_global_locks {
+	struct mutex open_file_mutex[NR_KERNFS_LOCKS];
+};
+
 enum kernfs_node_type {
 	KERNFS_DIR		= 0x0001,
 	KERNFS_FILE		= 0x0002,
-- 
2.30.2