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 1/4] kernfs: make ->attr.open RCU protected.
Date:   Wed, 11 May 2022 19:51:54 +1000
Message-Id: <20220511095157.478522-2-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?tOEMvVIYZTJLWCvsaNPH4kaYxJTJwnBTeT0+qh1I3uvkapokE+ALbVRYcBF4?=
 =?us-ascii?Q?5xSu61aaVVwkO3B9avDr1KdWYdW/Azz5AmzLRh+KH/M4+8kUzG8M/ubcv23y?=
 =?us-ascii?Q?FvMf7HQweg6OOEVzgngqa2Y8eErDdb8iM9mDEt42ArrZBk5w6zGswUd9AyCZ?=
 =?us-ascii?Q?2B6o9YQxAG/B6KTp9Vn81jTT9vguHQXzxAK2+bssw7RtP0Rw0LsUm26bkIsu?=
 =?us-ascii?Q?GBTZE9ycfQFSLRF6PLD7LSgGK7A4B4KSB4WlBLuQpX6eJ1pfjWPH2IPDU9Yn?=
 =?us-ascii?Q?MvumJAeT6Ch8otdSSdKp9TC1RtTas4ANQY8/efYOxsFVE/jrAVMQhTiJD3IO?=
 =?us-ascii?Q?CJokTOaKvuj5dzxCyAHP952euZyCl4qlTQeOzZj0gc0AXglPGvkfRPhGsDjh?=
 =?us-ascii?Q?+Ze1B6TW7JAkJ6ExSlurvIOvyoMuFj1jrIjlyfWykcy5ceek9IE5/vie12eQ?=
 =?us-ascii?Q?8KabiVCRbgJPChk8EoIge8gCG6jKZ6miBLxfo//b9BTjCCMGscIk3wYxYNK0?=
 =?us-ascii?Q?jQHk7T8PnEM1vVJs2q+PVZUAa94/a1vRpLyipV6l3wxEXuq0V9aC9Ihl4G8s?=
 =?us-ascii?Q?Qtste8aOxEVz/P2jv5IMaMBR1zVoMbQxv0zmnBfHJyDcEkXzyPGP6FP04jCL?=
 =?us-ascii?Q?G9tw8Hx/NWvLMqop3EqGAeWfDtJ+BWLk8E3k5HqX4HY3O+7EbQnVhwDWefEW?=
 =?us-ascii?Q?dKTz0RYOJDW23glps2uZSA/iF7BD2bv+mS0wGODA1ioPJYMYI6rEHwgqmdYD?=
 =?us-ascii?Q?kHLkEbLc47SyX30xQz4MDIQqhSsV39EmrdVQflNb/TSO2mK9LbhNBGaAch7S?=
 =?us-ascii?Q?LeicTdIDkBJJboHbDOep06x9UIISbfJE+5DqTFGLdfrlqz5suYa+smhs6uAF?=
 =?us-ascii?Q?bxQCTtrC+M8p/WtXnEW6fulnTKIlq4rOpnzF0XraRo9WHkBHBvc5lbrDvYKE?=
 =?us-ascii?Q?WOsn0BEmLtvdk4QAD9ij359l2MmcSe/yYnVvrtseUCMWxuWMhKaJwTfptWTb?=
 =?us-ascii?Q?7tLagaBr3sYHIeu2ckTkmV9CWlnMQeHC0r5u/NYRMKZ6uwdLh5Yrj/yijVZk?=
 =?us-ascii?Q?Yf8hwmrCKBGWUsKrD/ER84MyD1d1Ul53vJFVN1Pguwm3xfMePMYYA0S/lvwF?=
 =?us-ascii?Q?VHSiCmxRLQKwjthC+olhfAmu7Ql9ZQYKnoxRAb9j2tn/SGswCE578HxE88IZ?=
 =?us-ascii?Q?w18izglcUay/Y8LfitS94JZ0Njv5e9vPlQ73wfcAL403/SXROIZRnCRw3QVt?=
 =?us-ascii?Q?QZUyI/Ezw1sZ2LAy+Hh2N1FuT5/czw+/l0X83Dvly3Gb0kZdtbj/AtpXgAPo?=
 =?us-ascii?Q?IlsM7O88ElXwX7YxF/2tGQV9hd8jb21mz4Ev7ySabRxTaOqclAHFHDASQD9v?=
 =?us-ascii?Q?h8p+dvTJ4sVbS8216nKCu13c7qcvaceb9pAvo8mPO3Prd9IirmbhcTyPkJ9+?=
 =?us-ascii?Q?OKfEBGVj/LQZI79naWmWtsVTPsIpAP5FmShUTQN1LOyPuZRS6PMvez/4zmgt?=
 =?us-ascii?Q?D9RC43FNDMB7827dSPvP2FKwUg1jKtvjDlCj8Ry1Nkzl8IVqllPo5GENVYcn?=
 =?us-ascii?Q?jhSrv59TTRV6dK0Q+Z7dEDHi82akNIXSf6trI649JhsmH89Q/bLw89QH8yJn?=
 =?us-ascii?Q?gMDyCmc7RDSVWs8Wcp4UjojKbqrUcnKjYVVThnVNcUHYSiXL8ZwwibVpFbeq?=
 =?us-ascii?Q?WGc2VuCAtkCY3sZDPQ9j5mYzBWke56HElJSahJ0cKah6YzCRLXH0iiM7Czpx?=
 =?us-ascii?Q?kjwp2ddNV7tzMMYpxkhbte9/MqfEl+w=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 473eaaef-1c3a-438a-d69a-08da3333ebc7
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:11.9843
 (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: o+qLZE3YBadgrnOZexdjJTU2jfaHeend+2EZxq3lqQ63+etLZMyI4G/Al7j41G/+koIdNT9WR1Q4D4cqZMelHQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR10MB3718
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 malwarescore=0 mlxlogscore=999
 spamscore=0 bulkscore=0 adultscore=0 suspectscore=0 mlxscore=0
 phishscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2202240000 definitions=main-2205110044
X-Proofpoint-GUID: Ik3ukUpnngKJ5dt7OXEbEtXqm_pAANUh
X-Proofpoint-ORIG-GUID: Ik3ukUpnngKJ5dt7OXEbEtXqm_pAANUh
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

After removal of kernfs_open_node->refcnt in the previous patch,
kernfs_open_node_lock can be removed as well by making ->attr.open
RCU protected. kernfs_put_open_node can delegate freeing to ->attr.open
to RCU and other readers of ->attr.open can do so under rcu_read_(un)lock.

Suggested by: Al Viro <viro@zeniv.linux.org.uk>
Signed-off-by: Imran Khan <imran.f.khan@oracle.com>
---
 fs/kernfs/file.c       | 141 +++++++++++++++++++++++++++--------------
 include/linux/kernfs.h |   2 +-
 2 files changed, 96 insertions(+), 47 deletions(-)

diff --git a/fs/kernfs/file.c b/fs/kernfs/file.c
index e3abfa843879..796f27333846 100644
--- a/fs/kernfs/file.c
+++ b/fs/kernfs/file.c
@@ -23,16 +23,16 @@
  * for each kernfs_node with one or more open files.
  *
  * kernfs_node->attr.open points to kernfs_open_node.  attr.open is
- * protected by kernfs_open_node_lock.
+ * 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_SPINLOCK(kernfs_open_node_lock);
 static DEFINE_MUTEX(kernfs_open_file_mutex);
 
 struct kernfs_open_node {
+	struct rcu_head		rcu_head;
 	atomic_t		event;
 	wait_queue_head_t	poll;
 	struct list_head	files; /* goes through kernfs_open_file.list */
@@ -51,6 +51,50 @@ struct kernfs_open_node {
 static DEFINE_SPINLOCK(kernfs_notify_lock);
 static struct kernfs_node *kernfs_notify_list = KERNFS_NOTIFY_EOL;
 
+/*
+ * Raw deref RCU protected kn->attr.open.
+ * If both @of->list and @kn->attr.open->files are non empty, we can safely
+ * assume that @of is on @kn->attr.open and hence @kn->attr.open will not vanish
+ * and raw derefeencing is safe here.
+ */
+static struct kernfs_open_node *
+kernfs_deref_on_raw(struct kernfs_open_file *of, struct kernfs_node *kn)
+{
+	struct kernfs_open_node *on;
+
+	if (list_empty(&of->list))
+		return NULL;
+
+	on = rcu_dereference_raw(kn->attr.open);
+
+	if (list_empty(&on->files))
+		return NULL;
+	else
+		return on;
+}
+
+/*
+ * Deref ->attr.open corresponding to @kn while holding kernfs_open_file_mutex.
+ * ->attr.open is modified under kernfs_open_file_mutex. So it can be safely
+ * accessed outside RCU read-side critical section, while holding the mutex.
+ */
+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));
+}
+
+/*
+ * Check ->attr.open corresponding to @kn while holding kernfs_open_file_mutex.
+ * ->attr.open is modified under kernfs_open_file_mutex. So it can be safely
+ * accessed outside RCU read-side critical section, while holding the mutex.
+ */
+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));
+}
+
 static struct kernfs_open_file *kernfs_of(struct file *file)
 {
 	return ((struct seq_file *)file->private_data)->private;
@@ -156,8 +200,12 @@ static void kernfs_seq_stop(struct seq_file *sf, void *v)
 static int kernfs_seq_show(struct seq_file *sf, void *v)
 {
 	struct kernfs_open_file *of = sf->private;
+	struct kernfs_open_node *on = kernfs_deref_on_raw(of, of->kn);
+
+	if (!on)
+		return -EINVAL;
 
-	of->event = atomic_read(&of->kn->attr.open->event);
+	of->event = atomic_read(&unrcu_pointer(on)->event);
 
 	return of->kn->attr.ops->seq_show(sf, v);
 }
@@ -180,6 +228,7 @@ static ssize_t kernfs_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
 	struct kernfs_open_file *of = kernfs_of(iocb->ki_filp);
 	ssize_t len = min_t(size_t, iov_iter_count(iter), PAGE_SIZE);
 	const struct kernfs_ops *ops;
+	struct kernfs_open_node *on;
 	char *buf;
 
 	buf = of->prealloc_buf;
@@ -201,7 +250,11 @@ static ssize_t kernfs_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
 		goto out_free;
 	}
 
-	of->event = atomic_read(&of->kn->attr.open->event);
+	on = kernfs_deref_on_raw(of, of->kn);
+	if (!on)
+		return -EINVAL;
+
+	of->event = atomic_read(&unrcu_pointer(on)->event);
 	ops = kernfs_ops(of->kn);
 	if (ops->read)
 		len = ops->read(of, buf, len, iocb->ki_pos);
@@ -519,36 +572,29 @@ static int kernfs_get_open_node(struct kernfs_node *kn,
 {
 	struct kernfs_open_node *on, *new_on = NULL;
 
- retry:
 	mutex_lock(&kernfs_open_file_mutex);
-	spin_lock_irq(&kernfs_open_node_lock);
-
-	if (!kn->attr.open && new_on) {
-		kn->attr.open = new_on;
-		new_on = NULL;
-	}
-
-	on = kn->attr.open;
-	if (on)
-		list_add_tail(&of->list, &on->files);
-
-	spin_unlock_irq(&kernfs_open_node_lock);
-	mutex_unlock(&kernfs_open_file_mutex);
+	on = kernfs_deref_on_protected(kn);
 
 	if (on) {
-		kfree(new_on);
+		list_add_tail(&of->list, &on->files);
+		mutex_unlock(&kernfs_open_file_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);
+			return -ENOMEM;
+		}
+		atomic_set(&new_on->event, 1);
+		init_waitqueue_head(&new_on->poll);
+		INIT_LIST_HEAD(&new_on->files);
+		list_add_tail(&of->list, &new_on->files);
+		rcu_assign_pointer(kn->attr.open, new_on);
 	}
+	mutex_unlock(&kernfs_open_file_mutex);
 
-	/* not there, initialize a new one and retry */
-	new_on = kmalloc(sizeof(*new_on), GFP_KERNEL);
-	if (!new_on)
-		return -ENOMEM;
-
-	atomic_set(&new_on->event, 1);
-	init_waitqueue_head(&new_on->poll);
-	INIT_LIST_HEAD(&new_on->files);
-	goto retry;
+	return 0;
 }
 
 /**
@@ -567,24 +613,25 @@ static int kernfs_get_open_node(struct kernfs_node *kn,
 static void kernfs_unlink_open_file(struct kernfs_node *kn,
 				 struct kernfs_open_file *of)
 {
-	struct kernfs_open_node *on = kn->attr.open;
-	unsigned long flags;
+	struct kernfs_open_node *on;
 
 	mutex_lock(&kernfs_open_file_mutex);
-	spin_lock_irqsave(&kernfs_open_node_lock, flags);
+
+	on = kernfs_deref_on_protected(kn);
+	if (!on) {
+		mutex_unlock(&kernfs_open_file_mutex);
+		return;
+	}
 
 	if (of)
 		list_del(&of->list);
 
-	if (list_empty(&on->files))
-		kn->attr.open = NULL;
-	else
-		on = NULL;
+	if (list_empty(&on->files)) {
+		rcu_assign_pointer(kn->attr.open, NULL);
+		kfree_rcu(on, rcu_head);
+	}
 
-	spin_unlock_irqrestore(&kernfs_open_node_lock, flags);
 	mutex_unlock(&kernfs_open_file_mutex);
-
-	kfree(on);
 }
 
 static int kernfs_fop_open(struct inode *inode, struct file *file)
@@ -774,17 +821,16 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 	 * check under kernfs_open_file_mutex will ensure bailing out if
 	 * ->attr.open became NULL while waiting for the mutex.
 	 */
-	if (!kn->attr.open)
+	if (!rcu_access_pointer(kn->attr.open))
 		return;
 
 	mutex_lock(&kernfs_open_file_mutex);
-	if (!kn->attr.open) {
+	on = kernfs_check_on_protected(kn);
+	if (!on) {
 		mutex_unlock(&kernfs_open_file_mutex);
 		return;
 	}
 
-	on = kn->attr.open;
-
 	list_for_each_entry(of, &on->files, list) {
 		struct inode *inode = file_inode(of->file);
 
@@ -815,7 +861,10 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 __poll_t kernfs_generic_poll(struct kernfs_open_file *of, poll_table *wait)
 {
 	struct kernfs_node *kn = kernfs_dentry_node(of->file->f_path.dentry);
-	struct kernfs_open_node *on = kn->attr.open;
+	struct kernfs_open_node *on = kernfs_deref_on_raw(of, kn);
+
+	if (!on)
+		return EPOLLERR;
 
 	poll_wait(of->file, &on->poll, wait);
 
@@ -922,13 +971,13 @@ void kernfs_notify(struct kernfs_node *kn)
 		return;
 
 	/* kick poll immediately */
-	spin_lock_irqsave(&kernfs_open_node_lock, flags);
-	on = kn->attr.open;
+	rcu_read_lock();
+	on = rcu_dereference(kn->attr.open);
 	if (on) {
 		atomic_inc(&on->event);
 		wake_up_interruptible(&on->poll);
 	}
-	spin_unlock_irqrestore(&kernfs_open_node_lock, flags);
+	rcu_read_unlock();
 
 	/* schedule work to kick fsnotify */
 	spin_lock_irqsave(&kernfs_notify_lock, flags);
diff --git a/include/linux/kernfs.h b/include/linux/kernfs.h
index e2ae15a6225e..13f54f078a52 100644
--- a/include/linux/kernfs.h
+++ b/include/linux/kernfs.h
@@ -114,7 +114,7 @@ struct kernfs_elem_symlink {
 
 struct kernfs_elem_attr {
 	const struct kernfs_ops	*ops;
-	struct kernfs_open_node	*open;
+	struct kernfs_open_node __rcu	*open;
 	loff_t			size;
 	struct kernfs_node	*notify_next;	/* for kernfs_notify() */
 };
-- 
2.30.2