staging/dt3155: make copy_{to/from}_user and put_user typesafe
PATCH 1/1 staging/dt3155: make copy_{to/from}_user and put_user typesafe
This makes the kernel to user space data transfers typesafe and removes a number of unnecessary (void *) casts.
---
drivers/staging/dt3155/dt3155_drv.c +8 -10
@@ -528,6 +528,7 @@ static int dt3155_ioctl(struct inode *inode, unsigned long arg) {int minor =MINOR (inode->i_rdev);/* What device are we ioctl()'ing? */ +void __user *up = (void __user *)arg;if ( minor >=MAXBOARDS || minor <0 )return -ENODEV ;
@@ -554,7 +555,7 @@ static int dt3155_ioctl(struct inode *inode, {struct dt3155_config_s tmp; -if (copy_from_user ((void *)&tmp, (void *) arg,sizeof (tmp))) +if (copy_from_user (&tmp, up,sizeof (tmp)))return -EFAULT ;/* check for valid settings */ if (tmp.rows > DT3155_MAX_ROWS ||
@@ -572,8 +573,7 @@ static int dt3155_ioctl(struct inode *inode, }case DT3155_GET_CONFIG : { -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t) )) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }
@@ -593,8 +593,7 @@ static int dt3155_ioctl(struct inode *inode,return 0 ;quick_stop (minor); -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }
@@ -617,8 +616,7 @@ static int dt3155_ioctl(struct inode *inode, }dt3155_init_isr (minor); -if (copy_to_user ( (void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }
@@ -819,11 +817,11 @@ static ssize_t dt3155_read(struct file *filep, char __user *buf,/* make this an offset */ offset = frame_info_p->addr - dt3155_status[minor].mem_addr; -put_user (offset, (unsigned int *) buf); +put_user (offset, (unsigned int __user *)buf); buf +=sizeof (u32); -put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int *) buf); +put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int __user *)buf); buf +=sizeof (u32); -put_user (dt3155_status[minor].state, (unsigned int *) buf); +put_user (dt3155_status[minor].state, (unsigned int __user *)buf); buf +=sizeof (u32);if (copy_to_user (buf, frame_info_p,sizeof (frame_info_t)))return -EFAULT ;
Quoted 2 lines · H Hartley Sweeten
This makes the kernel to user space data transfers typesafe and removes a number of unnecessary (void *) casts.
Could you be more specific about what you mean by typesafe? There still seem to be casts in there. Although fewer than before :-)
Quoted 77 lines
Signed-off-by H Hartley Sweeten <[email protected]>Cc Greg Kroah-Hartman <[email protected]>Cc Scott Smedley <[email protected]>---
drivers/staging/dt3155/dt3155_drv.c +8
-11@@ -528,6 +528,7 @@ static int dt3155_ioctl(struct inode *inode, unsigned long arg) {int minor =MINOR (inode->i_rdev);/* What device are we ioctl()'ing? */ +void __user *up = (void __user *)arg;if ( minor >=MAXBOARDS || minor <0 )return -ENODEV ;@@ -554,7 +555,7 @@ static int dt3155_ioctl(struct inode *inode, {struct dt3155_config_s tmp; -if (copy_from_user ((void *)&tmp, (void *) arg,sizeof (tmp))) +if (copy_from_user (&tmp, up,sizeof (tmp)))return -EFAULT ;/* check for valid settings */ if (tmp.rows > DT3155_MAX_ROWS ||@@ -572,8 +573,7 @@ static int dt3155_ioctl(struct inode *inode, }case DT3155_GET_CONFIG : { -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t) )) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -593,8 +593,7 @@ static int dt3155_ioctl(struct inode *inode,return 0 ;quick_stop (minor); -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -617,8 +616,7 @@ static int dt3155_ioctl(struct inode *inode, }dt3155_init_isr (minor); -if (copy_to_user ( (void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -819,11 +817,11 @@ static ssize_t dt3155_read(struct file *filep, char __user *buf,/* make this an offset */ offset = frame_info_p->addr - dt3155_status[minor].mem_addr; -put_user (offset, (unsigned int *) buf); +put_user (offset, (unsigned int __user *)buf); buf +=sizeof (u32); -put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int *) buf); +put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int __user *)buf); buf +=sizeof (u32); -put_user (dt3155_status[minor].state, (unsigned int *) buf); +put_user (dt3155_status[minor].state, (unsigned int __user *)buf); buf +=sizeof (u32);if (copy_to_user (buf, frame_info_p,sizeof (frame_info_t)))return -EFAULT ; --To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Quoted 8 lines · Simon Horman
Quoted 2 lines · H Hartley Sweeten
This makes the kernel to user space data transfers typesafe and removes a number of unnecessary (void *) casts.
Could you be more specific about what you mean by typesafe? There still seem to be casts in there. Although fewer than before :-)
From
include/asm-generic/uaccess.h
static inline long copy_from_user(void *to,
const void __user * from, unsigned long n)
{
might_sleep();
if (access_ok(VERIFY_READ, from, n))
return __copy_from_user(to, from, n);
else
return n;
}static inline long copy_to_user(void __user *to,
const void *from, unsigned long n)
{
might_sleep();
if (access_ok(VERIFY_WRITE, to, n))
return __copy_to_user(to, from, n);
else
return n;
}Quoted 6 lines
Quoted 6 lines
Signed-off-by H Hartley Sweeten <[email protected]>Cc Greg Kroah-Hartman <[email protected]>Cc Scott Smedley <[email protected]>---
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 531
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c +1
-0@@ -528,6 +528,7 @@ static int dt3155_ioctl(struct inode *inode, unsigned long arg) {int minor =MINOR (inode->i_rdev);/* What device are we ioctl()'ing? */ +void __user *up = (void __user *)arg;
This cast is needed, and common, since 'arg' is passed as an unsigned long. The cast to __user memory space does not produce a sparse error.
Quoted 8 lines
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 557
Quoted 8 lines
drivers/staging/dt3155/dt3155_drv.c +0
-1if ( minor >=MAXBOARDS || minor <0 )return -ENODEV ;@@ -554,7 +555,7 @@ static int dt3155_ioctl(struct inode *inode, {struct dt3155_config_s tmp; -if (copy_from_user ((void *)&tmp, (void *) arg,sizeof (tmp)))
The fist void * cast is unnecessary, the second produces a sparse warning since copy_from_user expects 'arg' to be a __user space pointer.
Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 558
Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c +1
-0+if (copy_from_user (&tmp, up,sizeof (tmp)))
Using the 'up' (user pointer) variable quiets the warning and makes the function call typesafe (ok maybe that's the wrong term...).
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 576
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c +0
-2return -EFAULT ;/* check for valid settings */ if (tmp.rows > DT3155_MAX_ROWS ||@@ -572,8 +573,7 @@ static int dt3155_ioctl(struct inode *inode, }case DT3155_GET_CONFIG : { -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t) ))
Here 'arg' should be a __user space pointer and the second cast is not necessary.
Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 576
Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c +1
-0+if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))
Again, using 'up' fixes the sparse warning.
The two below are the same.
Quoted 27 lines
Quoted 27 lines
drivers/staging/dt3155/dt3155_drv.c +2
-4return -EFAULT ;return 0 ; }@@ -593,8 +593,7 @@ static int dt3155_ioctl(struct inode *inode,return 0 ;quick_stop (minor); -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -617,8 +616,7 @@ static int dt3155_ioctl(struct inode *inode, }dt3155_init_isr (minor); -if (copy_to_user ( (void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -819,11 +817,11 @@ static ssize_t dt3155_read(struct file *filep, char __user *buf,/* make this an offset */ offset = frame_info_p->addr - dt3155_status[minor].mem_addr;
Quoted 2 lines
drivers/staging/dt3155/dt3155_drv.c static ssize_t dt3155_read(struct file *filep, char __user *buf, · line 820
Quoted 2 lines
drivers/staging/dt3155/dt3155_drv.c +1
-1-put_user (offset, (unsigned int *) buf); +put_user (offset, (unsigned int __user *)buf);
For put_user, the second argument should be a __user pointer. 'buf' comes into the function correctly (char __user *) but needs the cast here so that the correct 'size' of data is copied to __user space. Same below.
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c static ssize_t dt3155_read(struct file *filep, char __user *buf, · line 827
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c +2
-2buf +=sizeof (u32); -put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int *) buf); +put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int __user *)buf); buf +=sizeof (u32); -put_user (dt3155_status[minor].state, (unsigned int *) buf); +put_user (dt3155_status[minor].state, (unsigned int __user *)buf); buf +=sizeof (u32);if (copy_to_user (buf, frame_info_p,sizeof (frame_info_t)))return -EFAULT ;
All of this seems pretty common in other kernel code. And it removes a number of the sparse warnings generated by this file.
Regards,
Hartley
Quoted 129 lines · H Hartley Sweeten
Quoted 8 lines · Simon Horman
Quoted 2 lines · H Hartley Sweeten
This makes the kernel to user space data transfers typesafe and removes a number of unnecessary (void *) casts.
Could you be more specific about what you mean by typesafe? There still seem to be casts in there. Although fewer than before :-)
From
include/asm-generic/uaccess.hstatic inline long copy_from_user(void *to,
const void__user* from, unsigned long n){ might_sleep(); if (access_ok(VERIFY_READ, from, n)) return __copy_from_user(to, from, n); else return n; }static inline long copy_to_user(void
__user*to,
const void *from, unsigned long n){ might_sleep(); if (access_ok(VERIFY_WRITE, to, n)) return __copy_to_user(to, from, n); else return n; }Quoted 6 lines
Quoted 6 lines
Signed-off-by H Hartley Sweeten <[email protected]>Cc Greg Kroah-Hartman <[email protected]>Cc Scott Smedley <[email protected]>---
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 531
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c +1
-0@@ -528,6 +528,7 @@ static int dt3155_ioctl(struct inode *inode, unsigned long arg) {int minor =MINOR (inode->i_rdev);/* What device are we ioctl()'ing? */ +void __user *up = (void __user *)arg;This cast is needed, and common, since 'arg' is passed as an unsigned long. The cast to
__usermemory space does not produce a sparse error.Quoted 8 lines
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 557
Quoted 8 lines
drivers/staging/dt3155/dt3155_drv.c +0
-1if ( minor >=MAXBOARDS || minor <0 )return -ENODEV ;@@ -554,7 +555,7 @@ static int dt3155_ioctl(struct inode *inode, {struct dt3155_config_s tmp; -if (copy_from_user ((void *)&tmp, (void *) arg,sizeof (tmp)))The fist void * cast is unnecessary, the second produces a sparse warning since
copy_from_userexpects 'arg' to be a__userspace pointer.Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 558
Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c +1
-0+if (copy_from_user (&tmp, up,sizeof (tmp)))Using the 'up' (user pointer) variable quiets the warning and makes the function call typesafe (ok maybe that's the wrong term...).
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 576
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c +0
-2return -EFAULT ;/* check for valid settings */ if (tmp.rows > DT3155_MAX_ROWS ||@@ -572,8 +573,7 @@ static int dt3155_ioctl(struct inode *inode, }case DT3155_GET_CONFIG : { -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t) ))Here 'arg' should be a
__userspace pointer and the second cast is not necessary.Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c static int dt3155_ioctl(struct inode *inode, · line 576
Quoted 1 line
drivers/staging/dt3155/dt3155_drv.c +1
-0+if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))Again, using 'up' fixes the sparse warning.
The two below are the same.
Quoted 27 lines
Quoted 27 lines
drivers/staging/dt3155/dt3155_drv.c +2
-4return -EFAULT ;return 0 ; }@@ -593,8 +593,7 @@ static int dt3155_ioctl(struct inode *inode,return 0 ;quick_stop (minor); -if (copy_to_user ((void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -617,8 +616,7 @@ static int dt3155_ioctl(struct inode *inode, }dt3155_init_isr (minor); -if (copy_to_user ( (void *) arg, (void *) &dt3155_status[minor], -sizeof (dt3155_status_t))) +if (copy_to_user (up, &dt3155_status[minor],sizeof (dt3155_status_t)))return -EFAULT ;return 0 ; }@@ -819,11 +817,11 @@ static ssize_t dt3155_read(struct file *filep, char __user *buf,/* make this an offset */ offset = frame_info_p->addr - dt3155_status[minor].mem_addr;Quoted 2 lines
drivers/staging/dt3155/dt3155_drv.c static ssize_t dt3155_read(struct file *filep, char __user *buf, · line 820
Quoted 2 lines
drivers/staging/dt3155/dt3155_drv.c +1
-1-put_user (offset, (unsigned int *) buf); +put_user (offset, (unsigned int __user *)buf);For
put_user, the second argument should be a__userpointer. 'buf' comes into the function correctly (char__user*) but needs the cast here so that the correct 'size' of data is copied to__userspace. Same below.Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c static ssize_t dt3155_read(struct file *filep, char __user *buf, · line 827
Quoted 9 lines
drivers/staging/dt3155/dt3155_drv.c +2
-2buf +=sizeof (u32); -put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int *) buf); +put_user ( dt3155_status[minor].fbuffer.frame_count, (unsigned int __user *)buf); buf +=sizeof (u32); -put_user (dt3155_status[minor].state, (unsigned int *) buf); +put_user (dt3155_status[minor].state, (unsigned int __user *)buf); buf +=sizeof (u32);if (copy_to_user (buf, frame_info_p,sizeof (frame_info_t)))return -EFAULT ;
Quoted 2 lines
All of this seems pretty common in other kernel code. And it removes a number of the sparse warnings generated by this file.
Hi,
thanks for the clarification. I agree that your patch is an improvement and I don't see any problems with it (other than typesafe possibly being the wrong term).