Skip to contentSkip to conversation

Btrfs: do not overwrite error return value in the balance ioctl

PATCH Superseded [email protected] 3 participants 6 messages Dec 14, 2018 – Jan 8, 2019 Btrfs file system

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Btrfs: do not overwrite error return value in the balance ioctl

From: Filipe Manana <[email protected]>

If the call to btrfs_balance() failed we would overwrite the error returned to user space with -EFAULT if the call to copy_to_user() failed as well. Fix that by calling copy_to_user() only if btrfs_balance() returned success.

---
 fs/btrfs/ioctl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/ioctl.c +1 -1
index abe45fd97ab5..4ad7288f77d0 100644
@@ -4707,7 +4707,7 @@ static long btrfs_ioctl_balance(struct file *file, void __user *arg)
 	ret = btrfs_balance(fs_info, bctl, bargs);
 	bctl = NULL;
 
-	if (arg) {
+	if (ret == 0 && arg) {
 		if (copy_to_user(arg, bargs, sizeof(*bargs)))
 			ret = -EFAULT;
 	}
Signature · 1 line
2.11.0
#1 lore raw
Quoted 18 lines · On 12/15/2018 03:45 AM, [email protected] wrote:

From: Filipe Manana <[email protected]>

If the call to btrfs_balance() failed we would overwrite the error returned to user space with -EFAULT if the call to copy_to_user() failed as well. Fix that by calling copy_to_user() only if btrfs_balance() returned success.

---
  fs/btrfs/ioctl.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/ioctl.c +0 -0
index abe45fd97ab5..4ad7288f77d0 100644

fs/btrfs/ioctl.c static long btrfs_ioctl_balance(struct file *file, void __user *arg) · line 4713

Quoted 8 lines
fs/btrfs/ioctl.c +1 -1
@@ -4707,7 +4707,7 @@ static long btrfs_ioctl_balance(struct file *file, void __user *arg)
  	ret = btrfs_balance(fs_info, bctl, bargs);
  	bctl = NULL;
 
-	if (arg) {
+	if (ret == 0 && arg) {
  		if (copy_to_user(arg, bargs, sizeof(*bargs)))
  			ret = -EFAULT;
  	}

This changes the BTRFS_IOC_BALANCE_V2 semantics.

Originally, if BTRFS_IOC_BALANCE_V2 is failed/canceled we do update bargs [1] and copy to user land, but after this patch we copy only if the ioctl is successful. I doubt if David is OK with that.

[1]
----------
3717 int btrfs_balance(struct btrfs_fs_info *fs_info,
3718 struct btrfs_balance_control *bctl,
3719 struct btrfs_ioctl_balance_args *bargs)
3720 {
::

3855 ret = __btrfs_balance(fs_info);
3856
3857 mutex_lock(&fs_info->balance_mutex);
3858 clear_bit(BTRFS_FS_BALANCE_RUNNING, &fs_info->flags);
3859
3860 if (bargs) {
3861 memset(bargs, 0, sizeof(*bargs));
3862 btrfs_update_ioctl_balance_args(fs_info, bargs);
3863 }

#2 lore raw
Quoted 33 lines · Anand Jain
Quoted 18 lines · On 12/15/2018 03:45 AM, [email protected] wrote:

From: Filipe Manana <[email protected]>

If the call to btrfs_balance() failed we would overwrite the error returned to user space with -EFAULT if the call to copy_to_user() failed as well. Fix that by calling copy_to_user() only if btrfs_balance() returned success.

---
  fs/btrfs/ioctl.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/ioctl.c +0 -0
index abe45fd97ab5..4ad7288f77d0 100644

fs/btrfs/ioctl.c static long btrfs_ioctl_balance(struct file *file, void __user *arg) · line 4713

Quoted 8 lines
fs/btrfs/ioctl.c +1 -1
@@ -4707,7 +4707,7 @@ static long btrfs_ioctl_balance(struct file *file, void __user *arg)
      ret = btrfs_balance(fs_info, bctl, bargs);
      bctl = NULL;
 
-     if (arg) {
+     if (ret == 0 && arg) {
              if (copy_to_user(arg, bargs, sizeof(*bargs)))
                      ret = -EFAULT;
      }

This changes the BTRFS_IOC_BALANCE_V2 semantics.

Quoted 3 lines

Originally, if BTRFS_IOC_BALANCE_V2 is failed/canceled we do update bargs [1] and copy to user land, but after this patch we copy only if the ioctl is successful. I doubt if David is OK with that.

I thought about that. But that logic, if it's really in use by someone (something) out there then they must be treating -EFAULT differently from any other error.
Because if copy_to_user() fails it means it didn't copy all bytes it was so supposed to (its return value is number of bytes not copied), so the arguments structure ends up in an inconsistent state.

Quoted 19 lines

[1]
----------
3717 int btrfs_balance(struct btrfs_fs_info *fs_info,
3718 struct btrfs_balance_control *bctl,
3719 struct btrfs_ioctl_balance_args *bargs)
3720 {
::

3855 ret = __btrfs_balance(fs_info);
3856
3857 mutex_lock(&fs_info->balance_mutex);
3858 clear_bit(BTRFS_FS_BALANCE_RUNNING, &fs_info->flags);
3859
3860 if (bargs) {
3861 memset(bargs, 0, sizeof(*bargs));
3862 btrfs_update_ioctl_balance_args(fs_info, bargs);
3863 }

#3 lore raw
Quoted 38 lines · Filipe Manana
Quoted 33 lines · Anand Jain
Quoted 18 lines · On 12/15/2018 03:45 AM, [email protected] wrote:

From: Filipe Manana <[email protected]>

If the call to btrfs_balance() failed we would overwrite the error returned to user space with -EFAULT if the call to copy_to_user() failed as well. Fix that by calling copy_to_user() only if btrfs_balance() returned success.

---
  fs/btrfs/ioctl.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/ioctl.c +0 -0
index abe45fd97ab5..4ad7288f77d0 100644

fs/btrfs/ioctl.c static long btrfs_ioctl_balance(struct file *file, void __user *arg) · line 4713

Quoted 8 lines
fs/btrfs/ioctl.c +1 -1
@@ -4707,7 +4707,7 @@ static long btrfs_ioctl_balance(struct file *file, void __user *arg)
      ret = btrfs_balance(fs_info, bctl, bargs);
      bctl = NULL;
 
-     if (arg) {
+     if (ret == 0 && arg) {
              if (copy_to_user(arg, bargs, sizeof(*bargs)))
                      ret = -EFAULT;
      }

This changes the BTRFS_IOC_BALANCE_V2 semantics.

Quoted 3 lines

Originally, if BTRFS_IOC_BALANCE_V2 is failed/canceled we do update bargs [1] and copy to user land, but after this patch we copy only if the ioctl is successful. I doubt if David is OK with that.

Quoted 6 lines

I thought about that. But that logic, if it's really in use by someone (something) out there then they must be treating -EFAULT differently from any other error.
Because if copy_to_user() fails it means it didn't copy all bytes it was so supposed to (its return value is number of bytes not copied), so the arguments structure ends up in an inconsistent state.

The balance ioctl as used in btrfs-progs expects valid contents of the bargs even if the ioctl returns negative value, with errno set to ECANCELED:

https://github.com/kdave/btrfs-progs/blob/master/cmds-balance.c#L458

So the condition would need to take that into account

	if ((ret == 0 || ret == -ECANCELED) && arg)

I haven't found any other error that would need to be whitelisted here.

#4 lore raw

PATCH v2 1/1 Btrfs: do not overwrite error return value in the balance ioctl

In reply to [email protected]

From: Filipe Manana <[email protected]>

If the call to btrfs_balance() failed we would overwrite the error returned to user space with -EFAULT if the call to copy_to_user() failed as well. Fix that by calling copy_to_user() only if btrfs_balance() returned success or was canceled.

---

V2: Considered the case where balance is canceled.

 fs/btrfs/ioctl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/ioctl.c +1 -1
index d0da86ac53bf..8dbb4ed07da1 100644
@@ -4768,7 +4768,7 @@ static long btrfs_ioctl_balance(struct file *file, void __user *arg)
 	ret = btrfs_balance(fs_info, bctl, bargs);
 	bctl = NULL;
 
-	if (arg) {
+	if ((ret == 0 || ret == -ECANCELED) && arg) {
 		if (copy_to_user(arg, bargs, sizeof(*bargs)))
 			ret = -EFAULT;
 	}
Signature · 1 line
2.11.0
Reviewed-by on v2 1/1
#5 lore raw
Quoted 8 lines · On Tue, Jan 08, 2019 at 11:42:01AM +0000, [email protected] wrote:

From: Filipe Manana <[email protected]>

If the call to btrfs_balance() failed we would overwrite the error returned to user space with -EFAULT if the call to copy_to_user() failed as well. Fix that by calling copy_to_user() only if btrfs_balance() returned success or was canceled.