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 v2 1/5] kernfs: Rename kernfs_put_open_node to kernfs_unlink_open_file.
Date:   Wed,  4 May 2022 19:51:19 +1000
Message-Id: <20220504095123.295859-2-imran.f.khan@oracle.com>
In-Reply-To: <20220504095123.295859-1-imran.f.khan@oracle.com>
References: <20220504095123.295859-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?k/+w2/7P4LojH50QBZqKkifP7mkNGEsxlVm1EIrE7fhIzGQRfciUrRjn192u?=
 =?us-ascii?Q?R2KgX4c4MLTjX2D0B8ZfmFGdaJ9CIyiqXGoEbkETMZhn0UPIiJrUU71O0LH1?=
 =?us-ascii?Q?BGPI4w+Vs9ucUaMrSs9ipvigS6h3L7INov/qHdP6y7ichYZw4PCJt+mauOoS?=
 =?us-ascii?Q?lYc/HXdlDI38RetNq0Lx7fgcia6VGmkIcfZcApsSicXokYiWN1KhnVXlvu8D?=
 =?us-ascii?Q?sdpkTpdlWbhWQ3iCcNLGtx8K7CzRRHxIIpCG0/ieKygAaY0TZmNH2jv/tcX5?=
 =?us-ascii?Q?9RIvHswuuxBh83Vg/iK+BABMDCKDDhypix37459R2gKdvF0lzj8sceD+fk8H?=
 =?us-ascii?Q?WB2expebvgSN0MFRolSRxhmeo4yKW3wnClVTUZ+cjpo8P4hDEWtPG+gxoNop?=
 =?us-ascii?Q?8vyewKVDAQI47NGfd3Pc1+pXm9DNysAso8frwXhgUjKCCzQx5cZCUvqTRmNh?=
 =?us-ascii?Q?H/4ayVPZ+Kh3LXViiOGpysSdc7qh/f/nCFS6hM1Pmc7r9VNZ1a4jo1PzIAwo?=
 =?us-ascii?Q?BDHqRSkpdiO3p76IZFB+zVoDeVKVeU21YAf2glUbK+jIhCo4ORM/UjqE08hy?=
 =?us-ascii?Q?PlruplgRH+PkEhCC8khv4HnVak16FI5U46m9Ubj17PwvpNG9Zodk0TpgBqA0?=
 =?us-ascii?Q?ZyW98go1cUqmoNzIK6gKqLetDA1SRMh8Hb7cY9X0bzqKCTZ6mLvzoIUjaaXM?=
 =?us-ascii?Q?WKzgP9ngiiImsPRNcjqVF4GggwwGcV8ucJ+N2FEnOjwczyHwUuQuI+ORrKOV?=
 =?us-ascii?Q?bENIkoCMhNXQJVxl5OLObRtWoZ8noCdc3rPqb4ifDxKoPSn+TplkoXS+l4S1?=
 =?us-ascii?Q?gYL4RgPgaDJGIkEahl5QRA7kbvHMcXYyMrHy8bHIC+M5vNGLS18VLM2gBtyZ?=
 =?us-ascii?Q?tvDLNYJQUnRcmcWGbw+3qBySbZ+3vTZqoxIN9Y4tLwCSFNTl6+raiCligDvC?=
 =?us-ascii?Q?KTixX1gY2VAjXLwSv2O0X3ZGh9MeVNZoqsX2isoPMXkxajKmdI+Ka3wUmVFr?=
 =?us-ascii?Q?WRmDa5EJAVJenwHORjT6MyHKXZAS7LmU55HzdNq4lN4UlZj4bhYibsg+OKey?=
 =?us-ascii?Q?h+QlRih2W9lKYbfl2CWOgz1xo4Sp4EjB1ovZ4sXmZ9eWlHG5g78q6XFTopxw?=
 =?us-ascii?Q?Totzw42JO7tKNz35AVeiZBzVIHwYU1UbD0Nq1x3AdMQfc5RAmM8/d+kwpBtM?=
 =?us-ascii?Q?aeHOCL+UoRcn1XjgqmgDCZXWshw1vLpZpvS+GEjT0Znv66gCFeP5aIdEnY+l?=
 =?us-ascii?Q?rX1B+SQHB/EkGKYWDGWtPfz4XmWwyQMZSCbP9BI16dMTlfYRQuF2QnnULTW7?=
 =?us-ascii?Q?02iJMfslPkkDGVOcEosMH6jmMLXuTYITdKeYSDILIDhAaAd6JmLZIYBQrSxg?=
 =?us-ascii?Q?8So3vUBjE74+1mV9DTiVmqYsyyjTKOlkYGVlAx/EVT1bmrrbEadZM+VHi74v?=
 =?us-ascii?Q?NthKVBa++BAakNn8gVyCiGfFpk6g6r+gB6qJiOzl5CygjKcV/oXvLsD94p4k?=
 =?us-ascii?Q?1qw0UPRSz7NHL3up+nqJBX+XW64CRHFGiDj1cEFa7qKHlIfsXGNZe4WpxnLe?=
 =?us-ascii?Q?4JjVeCRhBe1kXPNCq7m8x2bKyAFHqnMGljVC5F6HfCY7QiOWsSUzxNUbhuWw?=
 =?us-ascii?Q?3MxRtW32DjAVLVjunSmv0XaqBJ2YrlI5Npjw6g/IXWIgVOEFSLbV1quPEZaI?=
 =?us-ascii?Q?HadXVNwxWXDjuuaVBAYS0GlQvSlJZNSjLSx4+lNksM9i3Z5JF1r1GWpQqJNu?=
 =?us-ascii?Q?hOLfh0Le6qY5BTeYl9KxV4tzI4xMC6E=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 55ef05bd-9e40-495a-6901-08da2db3af62
X-MS-Exchange-CrossTenant-AuthSource: CO1PR10MB4468.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 May 2022 09:51:39.3547
 (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: yeEL7udoP8EjKy9yuyA+XK/N0tI3CiAKBHyohnH2wPsQ0ekc1YVz+foHq4ClksOrSQpJtZyc9aIO7GYRV7NL1g==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN6PR10MB2702
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.486,18.0.858
 definitions=2022-05-04_03:2022-05-02,2022-05-04 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 bulkscore=0 malwarescore=0
 spamscore=0 mlxlogscore=999 mlxscore=0 suspectscore=0 phishscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2202240000
 definitions=main-2205040065
X-Proofpoint-GUID: tksyVwjIRgZYppqzmHOSh85KegIdLYgi
X-Proofpoint-ORIG-GUID: tksyVwjIRgZYppqzmHOSh85KegIdLYgi
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 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

Since we are no longer using refcnt for kernfs_open_node instances, rename
kernfs_put_open_node to kernfs_unlink_open_file to reflect this change.
Also update function description and inline comments accordingly.

Signed-off-by: Imran Khan <imran.f.khan@oracle.com>
---
 fs/kernfs/file.c | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/fs/kernfs/file.c b/fs/kernfs/file.c
index aea6968c979e..e3abfa843879 100644
--- a/fs/kernfs/file.c
+++ b/fs/kernfs/file.c
@@ -552,18 +552,19 @@ static int kernfs_get_open_node(struct kernfs_node *kn,
 }
 
 /**
- *	kernfs_put_open_node - put kernfs_open_node
+ *	kernfs_unlink_open_file - Unlink @of from @kn.
+ *
  *	@kn: target kernfs_node
  *	@of: associated kernfs_open_file
  *
- *	Put @kn->attr.open and unlink @of from the files list.  If
- *	list of associated open files becomes empty, disassociate and
- *	free kernfs_open_node.
+ *	Unlink @of from list of @kn's associated open files. If list of
+ *	associated open files becomes empty, disassociate and free
+ *	kernfs_open_node.
  *
  *	LOCKING:
  *	None.
  */
-static void kernfs_put_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;
@@ -703,7 +704,7 @@ static int kernfs_fop_open(struct inode *inode, struct file *file)
 	return 0;
 
 err_put_node:
-	kernfs_put_open_node(kn, of);
+	kernfs_unlink_open_file(kn, of);
 err_seq_release:
 	seq_release(inode, file);
 err_free:
@@ -749,7 +750,7 @@ static int kernfs_fop_release(struct inode *inode, struct file *filp)
 		mutex_unlock(&kernfs_open_file_mutex);
 	}
 
-	kernfs_put_open_node(kn, of);
+	kernfs_unlink_open_file(kn, of);
 	seq_release(inode, filp);
 	kfree(of->prealloc_buf);
 	kfree(of);
@@ -765,8 +766,15 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 	if (!(kn->flags & (KERNFS_HAS_MMAP | KERNFS_HAS_RELEASE)))
 		return;
 
-	on = kn->attr.open;
-	if (!on)
+	/*
+	 * lockless opportunistic check is safe below because no one is adding to
+	 * ->attr.open at this point of time. This check allows early bail out
+	 * if ->attr.open is already NULL. kernfs_unlink_open_file makes
+	 * ->attr.open NULL only while holding kernfs_open_file_mutex so below
+	 * check under kernfs_open_file_mutex will ensure bailing out if
+	 * ->attr.open became NULL while waiting for the mutex.
+	 */
+	if (!kn->attr.open)
 		return;
 
 	mutex_lock(&kernfs_open_file_mutex);
@@ -775,6 +783,8 @@ void kernfs_drain_open_files(struct kernfs_node *kn)
 		return;
 	}
 
+	on = kn->attr.open;
+
 	list_for_each_entry(of, &on->files, list) {
 		struct inode *inode = file_inode(of->file);
 
-- 
2.30.2