Skip to contentSkip to conversation

ksmbd: Use common error handling code in ksmbd_vfs_path_lookup()

PATCH In review Markus Elfring 2 participants 5 messages Oct 3, 2025 – Oct 4, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ksmbd: Use common error handling code in ksmbd_vfs_path_lookup()

From: Markus Elfring <[email protected]>
Date: Fri, 3 Oct 2025 20:26:56 +0200

Add a jump target so that a bit of exception handling can be better reused at the end of this function implementation.

---
 fs/smb/server/vfs.c | 32 ++++++++++++++------------------
 1 file changed, 14 insertions(+), 18 deletions(-)
fs/smb/server/vfs.c +14 -18
index 891ed2dc2b73..3535655b4d86 100644
@@ -94,17 +94,13 @@ static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
 	if (err)
 		return err;
 
-	if (unlikely(type != LAST_NORM)) {
-		path_put(path);
-		return -ENOENT;
-	}
+	if (unlikely(type != LAST_NORM))
+		goto put_path;
 
 	if (do_lock) {
 		err = mnt_want_write(path->mnt);
-		if (err) {
-			path_put(path);
-			return -ENOENT;
-		}
+		if (err)
+			goto put_path;
 
 		inode_lock_nested(path->dentry->d_inode, I_MUTEX_PARENT);
 		d = lookup_one_qstr_excl(&last, path->dentry, 0);
@@ -116,8 +112,7 @@ static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
 		}
 		inode_unlock(path->dentry->d_inode);
 		mnt_drop_write(path->mnt);
-		path_put(path);
-		return -ENOENT;
+		goto put_path;
 	}
 
 	d = lookup_noperm_unlocked(&last, path->dentry);
@@ -125,21 +120,22 @@ static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
 		dput(d);
 		d = ERR_PTR(-ENOENT);
 	}
-	if (IS_ERR(d)) {
-		path_put(path);
-		return -ENOENT;
-	}
+	if (IS_ERR(d))
+		goto put_path;
+
 	dput(path->dentry);
 	path->dentry = d;
 
 	if (test_share_config_flag(share_conf, KSMBD_SHARE_FLAG_CROSSMNT)) {
 		err = follow_down(path, 0);
-		if (err < 0) {
-			path_put(path);
-			return -ENOENT;
-		}
+		if (err < 0)
+			goto put_path;
 	}
 	return 0;
+
+put_path:
+	path_put(path);
+	return -ENOENT;
 }
 
 void ksmbd_vfs_query_maximal_access(struct mnt_idmap *idmap,
Signature · 1 line
2.51.0
#1 lore raw
Quoted 5 lines · Markus Elfring

From: Markus Elfring <[email protected]>
Date: Fri, 3 Oct 2025 20:26:56 +0200

Add a jump target so that a bit of exception handling can be better reused at the end of this function implementation.

I think this is a good cleanup - thanks. But I think it could be even better.

- rename the "path" parameter to "return_path" or similar.
- declare struct path path __free(path_-put) = {};
- change all "path->" instances to "path."
- remove all those path_put() calls, but leave the "return xxx"
- at the point of successful return, use

   return_path->dentry = no_free_ptr(path.dentry);
   return_path->mnt = no_free_ptr(path.mnt);
   return 0;

This is based on the pattern in kern_path_parent() and __start_removing_path().

Thanks,
NeilBrown

Quoted 78 lines
---
 fs/smb/server/vfs.c | 32 ++++++++++++++------------------
 1 file changed, 14 insertions(+), 18 deletions(-)
fs/smb/server/vfs.c +14 -18
index 891ed2dc2b73..3535655b4d86 100644
@@ -94,17 +94,13 @@ static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
 	if (err)
 		return err;
 
-	if (unlikely(type != LAST_NORM)) {
-		path_put(path);
-		return -ENOENT;
-	}
+	if (unlikely(type != LAST_NORM))
+		goto put_path;
 
 	if (do_lock) {
 		err = mnt_want_write(path->mnt);
-		if (err) {
-			path_put(path);
-			return -ENOENT;
-		}
+		if (err)
+			goto put_path;
 
 		inode_lock_nested(path->dentry->d_inode, I_MUTEX_PARENT);
 		d = lookup_one_qstr_excl(&last, path->dentry, 0);
@@ -116,8 +112,7 @@ static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
 		}
 		inode_unlock(path->dentry->d_inode);
 		mnt_drop_write(path->mnt);
-		path_put(path);
-		return -ENOENT;
+		goto put_path;
 	}
 
 	d = lookup_noperm_unlocked(&last, path->dentry);
@@ -125,21 +120,22 @@ static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
 		dput(d);
 		d = ERR_PTR(-ENOENT);
 	}
-	if (IS_ERR(d)) {
-		path_put(path);
-		return -ENOENT;
-	}
+	if (IS_ERR(d))
+		goto put_path;
+
 	dput(path->dentry);
 	path->dentry = d;
 
 	if (test_share_config_flag(share_conf, KSMBD_SHARE_FLAG_CROSSMNT)) {
 		err = follow_down(path, 0);
-		if (err < 0) {
-			path_put(path);
-			return -ENOENT;
-		}
+		if (err < 0)
+			goto put_path;
 	}
 	return 0;
+
+put_path:
+	path_put(path);
+	return -ENOENT;
 }
 
 void ksmbd_vfs_query_maximal_access(struct mnt_idmap *idmap,
Signature · 1 line
2.51.0
#2 lore raw

…> - declare struct path path __free(path_-put) = {};
…> return_path->dentry = no_free_ptr(path.dentry);

Quoted 5 lines
   return_path->mnt = no_free_ptr(path.mnt);
   return 0;

This is based on the pattern in kern_path_parent() and __start_removing_path().

Do you propose that affected software components may benefit more from the application of scope-based resource management?
https://elixir.bootlin.com/linux/v6.17/source/include/linux/path.h#L22-L28

Regards,
Markus

#3 lore raw
Quoted 11 lines · Markus Elfring

…> - declare struct path path __free(path_-put) = {};
…> return_path->dentry = no_free_ptr(path.dentry);

Quoted 5 lines
   return_path->mnt = no_free_ptr(path.mnt);
   return 0;

This is based on the pattern in kern_path_parent() and __start_removing_path().

Do you propose that affected software components may benefit more from the application of scope-based resource management?
https://elixir.bootlin.com/linux/v6.17/source/include/linux/path.h#L22-L28

Exactly. It doesn't suit every case, but if you are going to make changes to the exit paths of a function, I think it is worth considering if scope-based code will work well for the particular function.

Since v6.17 there has already been a net increase of 167 uses of __free (though some might be in comments....) and 1902 more uses for guard(). So at least some people think it is a good idea.

NeilBrown

#4 lore raw
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

This is based on the pattern in kern_path_parent() and __start_removing_path().

You influenced the software evolution also according to the availability of a function like kern_path_locked_negative().
https://elixir.bootlin.com/linux/v6.17/source/fs/namei.c#L2770-L2792

See also the following commits:
* 76a53de6f7ff0641570364234fb4489f4d4fc8e9 ("VFS/audit: introduce kern_path_parent() for audit") from 2025-09-23

* a681b7c17dd21d5aa0da391ceb27a2007ba970a4 ("fs: ensure that *path_locked*() helpers leave passed path pristine") from 2025-04-16

Quoted 8 lines
Quoted 3 lines

Do you propose that affected software components may benefit more from the application of scope-based resource management?
https://elixir.bootlin.com/linux/v6.17/source/include/linux/path.h#L22-L28

Exactly. It doesn't suit every case, but if you are going to make changes to the exit paths of a function, I think it is worth considering if scope-based code will work well for the particular function.

Is there a need to clarify possibilities for the usage of the macro “__free_path_put” further?

Regards,
Markus