Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Stephen Brennan <stephen.s.brennan@oracle.com>
To:     Alexander Viro <viro@zeniv.linux.org.uk>
Cc:     Stephen Brennan <stephen.s.brennan@oracle.com>,
        linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 2/3] namei: Standardize callers of filename_lookup()
Date:   Tue,  7 Sep 2021 13:50:42 -0700
Message-Id: <20210907205043.16768-3-stephen.s.brennan@oracle.com>
In-Reply-To: <20210907205043.16768-1-stephen.s.brennan@oracle.com>
References: <20210907205043.16768-1-stephen.s.brennan@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?BRkWAL6C5G5Z1KxQfCUhy7SL1LRYXQhHavInoBdu1asEczm+G1c/jgXMgq8g?=
 =?us-ascii?Q?NdFRpOGRWuzSBtK22u1JWlx5NsUiITSfb+EBCUdyQZrwPLhfOByo1IKACJhP?=
 =?us-ascii?Q?NhLy40WVR+1UukpFnNoFbSdTZnc0tXXBZUOX+XU8worgeinqMK5o+hIXiQIB?=
 =?us-ascii?Q?H3jwtFt+2e/HOi7R685ADYDV2G28zhOBr1XjRFFRdZi6EiLZrakRtNo1CF/Z?=
 =?us-ascii?Q?LnWaw9rPPpuU3wj6ToamuTYAJ90EhZrnJQ/6KuUhQYgpaqT2XwVgTRj6WqsS?=
 =?us-ascii?Q?9qx5xv8JvuItkoeeDcBeMVrZqsk9ZaTgbHub7o0Bbv9sAWX0CRE4rIA8LuS8?=
 =?us-ascii?Q?HYc3THUFw9VJ7hovapqzGa8hOyhI7lgn877lgroLfUQZ2LA9QOS4MvfUZ6Iu?=
 =?us-ascii?Q?NXcG6TBMzJ4UV7634fy1l0xCGxfOcWAa1n6+tlYhTXbsGW0f3IhaU5VhaxRy?=
 =?us-ascii?Q?zNszGlndQI0e85XuFc+Y1dDzvswQK5XPWy6Ahw7NWqyf3DVJSwpDmWcyeyCB?=
 =?us-ascii?Q?TLI2TbuglkITfx+LknFzdrSMM8bFUsHoutCGdeJnDC85nrSW196ogESgwfc8?=
 =?us-ascii?Q?beI8b7z+sm9r5R4fz2GjjudyBFVao2R5emPOG9ElT28nzT1aWv1EoknDXtLd?=
 =?us-ascii?Q?kXDJtOvPjSnmKo7ltEJCAmNJcG8Adp8G7fGkY49F23fahza3vqqhsYxz6J+5?=
 =?us-ascii?Q?6a550AhWCXXtxTYBftmxLcfxBaG4QMk5eYSmGGdJ6ujvjOeZ36jy/uM+I71z?=
 =?us-ascii?Q?azyHNbxuYJPNyo/URpIH7XnegSm/JvCnoXl/hA8LKblaytbrp1ORYminhAQL?=
 =?us-ascii?Q?Gwv+nDMh9UxSLNNhy5gYbhvqOzbGqzcYYFOn/1Vkh56CaQqBdA67/gSFjW2s?=
 =?us-ascii?Q?Zyp4lqH0VnnWQYcXtHT5nTsnsQXI+D6N+TltwNaB7MBNRFyVrTg4vN81TFX9?=
 =?us-ascii?Q?GCo4Y4nQviffRDTdBPQ3IFEn3nXX8SACBucdpCFy2HdhT0uFztxSXMvJ6loa?=
 =?us-ascii?Q?ZmL6QfDwSiKMGsHHsd6cdGn97DBZ94hSCB1+UVdh5FuE3Zq4jJBGZnhHSQGq?=
 =?us-ascii?Q?or+jYp2qKmPCOuhhZ5zWWulmrpjOpUA617cIFyfKjUCKYEUqxZUp61F4n8o7?=
 =?us-ascii?Q?8LYeu5UfFQN6IPibxdp3JwWfgEqd7IP9+x2hSsxrqUqbbpydpnQKYQuBEVEf?=
 =?us-ascii?Q?pbZ1T4Owv7mYgSea+TI2K26/AEK1ggbvzGkY122zSKWyT7odFZBglyty74J/?=
 =?us-ascii?Q?BWgpcOWPsNJwecM25uaEy/xkutsFC/mCyGliFvzIB6fSLu8DRKJmTtwbo/Ky?=
 =?us-ascii?Q?dFiKM0N/GrM36yQ7f5nBZc7C?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 427e157f-5138-4fa2-69d4-08d972412c58
X-MS-Exchange-CrossTenant-AuthSource: CH2PR10MB4166.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Sep 2021 20:50:49.2805
 (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: fXuI7uYXNEdLNg18FEtMptXw9umiDihK8Zz84qia4daxOu+d1CX80RzYSjGp3jCZMTJBylmbXhNK14G7Cj1Hbp56Z7CMOGQ3eV2UHxriPEo=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH2PR10MB4149
X-Proofpoint-Virus-Version: vendor=nai engine=6300 definitions=10100 signatures=668682
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 suspectscore=0
 malwarescore=0 spamscore=0 mlxscore=0 phishscore=0 mlxlogscore=999
 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2109030001 definitions=main-2109070130
X-Proofpoint-ORIG-GUID: a_UsUKEh1qK5YZxcKWXTdDD_5Meh9Syx
X-Proofpoint-GUID: a_UsUKEh1qK5YZxcKWXTdDD_5Meh9Syx
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

filename_lookup() has two variants, one which drops the caller's
reference to filename (filename_lookup), and one which does
not (__filename_lookup). This can be confusing as it's unusual to drop a
caller's reference. Remove filename_lookup, rename __filename_lookup
to filename_lookup, and convert all callers. The cost is a few slightly
longer functions, but the clarity is greater.

Link: https://lore.kernel.org/linux-fsdevel/YS+dstZ3xfcLxhoB@zeniv-ca.linux.org.uk/
Cc: Christoph Hellwig <hch@infradead.org>
Cc: Al Viro <viro@zeniv.linux.org.uk>
Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com>
---
 fs/fs_parser.c |  1 -
 fs/namei.c     | 41 ++++++++++++++++++++++++-----------------
 2 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/fs/fs_parser.c b/fs/fs_parser.c
index 980d44fd3a36..3df07c0e32b3 100644
--- a/fs/fs_parser.c
+++ b/fs/fs_parser.c
@@ -165,7 +165,6 @@ int fs_lookup_param(struct fs_context *fc,
 		return invalf(fc, "%s: not usable as path", param->key);
 	}
 
-	f->refcnt++; /* filename_lookup() drops our ref. */
 	ret = filename_lookup(param->dirfd, f, flags, _path, NULL);
 	if (ret < 0) {
 		errorf(fc, "%s: Lookup failure for '%s'", param->key, f->name);
diff --git a/fs/namei.c b/fs/namei.c
index f2af301cc79f..76871b7f127a 100644
--- a/fs/namei.c
+++ b/fs/namei.c
@@ -2467,7 +2467,7 @@ static int path_lookupat(struct nameidata *nd, unsigned flags, struct path *path
 	return err;
 }
 
-static int __filename_lookup(int dfd, struct filename *name, unsigned flags,
+int filename_lookup(int dfd, struct filename *name, unsigned flags,
 		    struct path *path, struct path *root)
 {
 	int retval;
@@ -2488,15 +2488,6 @@ static int __filename_lookup(int dfd, struct filename *name, unsigned flags,
 	return retval;
 }
 
-int filename_lookup(int dfd, struct filename *name, unsigned flags,
-		    struct path *path, struct path *root)
-{
-	int retval = __filename_lookup(dfd, name, flags, path, root);
-
-	putname(name);
-	return retval;
-}
-
 /* Returns 0 and nd will be valid on success; Retuns error, otherwise. */
 static int path_parentat(struct nameidata *nd, unsigned flags,
 				struct path *parent)
@@ -2571,8 +2562,14 @@ struct dentry *kern_path_locked(const char *name, struct path *path)
 
 int kern_path(const char *name, unsigned int flags, struct path *path)
 {
-	return filename_lookup(AT_FDCWD, getname_kernel(name),
-			       flags, path, NULL);
+	struct filename *filename;
+	int ret;
+
+	filename = getname_kernel(name);
+	ret = filename_lookup(AT_FDCWD, filename, flags, path, NULL);
+	putname(filename);
+	return ret;
+
 }
 EXPORT_SYMBOL(kern_path);
 
@@ -2588,10 +2585,15 @@ int vfs_path_lookup(struct dentry *dentry, struct vfsmount *mnt,
 		    const char *name, unsigned int flags,
 		    struct path *path)
 {
+	struct filename *filename;
 	struct path root = {.mnt = mnt, .dentry = dentry};
+	int ret;
+
+	filename = getname_kernel(name);
 	/* the first argument of filename_lookup() is ignored with root */
-	return filename_lookup(AT_FDCWD, getname_kernel(name),
-			       flags , path, &root);
+	ret = filename_lookup(AT_FDCWD, filename, flags, path, &root);
+	putname(filename);
+	return ret;
 }
 EXPORT_SYMBOL(vfs_path_lookup);
 
@@ -2795,8 +2797,13 @@ int path_pts(struct path *path)
 int user_path_at_empty(int dfd, const char __user *name, unsigned flags,
 		 struct path *path, int *empty)
 {
-	return filename_lookup(dfd, getname_flags(name, flags, empty),
-			       flags, path, NULL);
+	struct filename *filename;
+	int ret;
+
+	filename = getname_flags(name, flags, empty);
+	ret = filename_lookup(dfd, filename, flags, path, NULL);
+	putname(filename);
+	return ret;
 }
 EXPORT_SYMBOL(user_path_at_empty);
 
@@ -4421,7 +4428,7 @@ int do_linkat(int olddfd, struct filename *old, int newdfd,
 	if (flags & AT_SYMLINK_FOLLOW)
 		how |= LOOKUP_FOLLOW;
 retry:
-	error = __filename_lookup(olddfd, old, how, &old_path, NULL);
+	error = filename_lookup(olddfd, old, how, &old_path, NULL);
 	if (error)
 		goto out_putnames;
 
-- 
2.30.2