lib/iov_iter: Improved function for importing iovec[] from userpace.
Subsystems (3)
RFC PATCH 4/12 lib/iov_iter: Improved function for importing iovec[] from userpace.
import_iovec() has a 'pointer by reference' parameter to pass in the (on-stack) iov[] cache and return the address of a larger copy that the caller must free.
This is non-intuitive, faffy to setup, and not that efficient. Instead just pass in the address of the cache and return the address to free (on success) or PTR_ERR() (on error).
Additionally the size of the 'cache' is nominally variable but is often specified in a different source file to the actual cache passed. Use a structure for the 'cache' so that the compiler checks its size.
To avoid having to change everything at once the 'struct iov_iter *' is passed to rw_copy_check_uvector() which is renamed iovec_import() and returns the malloced address on success.
import_iovec() is then implemented using iovec_import().
The optimisation for zero length iov[] is removed (they'll now do a zero length copy_from_user() before returning success).
The check for oversize iov[] is moved inside the check for iov[] larger than the supplied cache.
The same changes have been made to the compat versions.
--- include/linux/uio.h | 14 ++++ lib/iov_iter.c | 194 +++++++++++++++++++++++----------------------------- 2 files changed, 100 insertions(+), 108 deletions(-)
include/linux/uio.h +14 -0
@@ -267,15 +267,29 @@ static inline void iov_iter_reexpand(struct iov_iter *i, size_t count)size_t hash_and_copy_to_iter (const void *addr,size_t bytes,void *hashp,struct iov_iter *i); +struct iovec_cache { +struct iovec iov[UIO_FASTIOV ]; +}; +ssize_t import_iovec (int type,const struct iovec __user * uvector,unsigned nr_segs,unsigned fast_segs,struct iovec **iov,struct iov_iter *i); +struct iovec *iovec_import (int type,const struct iovec __user * uvector, +unsigned int nr_segs,struct iovec_cache *cache, +struct iov_iter *i); +#ifdef CONFIG_COMPAT struct compat_iovec ;ssize_t compat_import_iovec (int type,const struct compat_iovec __user * uvector,unsigned nr_segs,unsigned fast_segs,struct iovec **iov,struct iov_iter *i); + +struct iovec *compat_iovec_import (int type, +const struct compat_iovec __user * uvector, +unsigned int nr_segs,struct iovec_cache *cache, +struct iov_iter *i); +#endif int import_single_range(int type, void __user *buf, size_t len,
lib/iov_iter.c +86 -108
288 lines not on this page · raw message
Signature · 5 lines
1.8.1.2 - Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)
RFC PATCH 4/12 lib/iov_iter: Improved function for importing iovec[] from userpace.
Quoted 373 lines
-----Original Message-----
From: David Laight
Sent: 31 March 2020 14:52
To: Linux Kernel Mailing List <[email protected]>
Subject: [RFC PATCH 04/12]lib/iov_iter: Improved function for importing iovec[] from userpace.
import_iovec()has a 'pointer by reference' parameter to pass in the (on-stack) iov[] cache and return the address of a larger copy that the caller must free.
This is non-intuitive, faffy to setup, and not that efficient. Instead just pass in the address of the cache and return the address to free (on success) orPTR_ERR()(on error).Additionally the size of the 'cache' is nominally variable but is often specified in a different source file to the actual cache passed. Use a structure for the 'cache' so that the compiler checks its size.
To avoid having to change everything at once the 'struct
iov_iter*' is passed torw_copy_check_uvector()which is renamediovec_import()and returns the malloced address on success.
import_iovec()is then implemented usingiovec_import().The optimisation for zero length iov[] is removed (they'll now do a zero length
copy_from_user()before returning success).The check for oversize iov[] is moved inside the check for iov[] larger than the supplied cache.
The same changes have been made to the compat versions.
Signed-off-by David Laight <[email protected]>--- include/linux/uio.h | 14 ++++ lib/iov_iter.c | 194 +++++++++++++++++++++++----------------------------- 2 files changed, 100 insertions(+), 108 deletions(-)include/linux/uio.h +14
-0@@ -267,15 +267,29 @@ static inline void iov_iter_reexpand(struct iov_iter *i, size_t count)size_t hash_and_copy_to_iter (const void *addr,size_t bytes,void *hashp,struct iov_iter *i); +struct iovec_cache { +struct iovec iov[UIO_FASTIOV ]; +}; +ssize_t import_iovec (int type,const struct iovec __user * uvector,unsigned nr_segs,unsigned fast_segs,struct iovec **iov,struct iov_iter *i); +struct iovec *iovec_import (int type,const struct iovec __user * uvector, +unsigned int nr_segs,struct iovec_cache *cache, +struct iov_iter *i); +#ifdef CONFIG_COMPAT struct compat_iovec ;ssize_t compat_import_iovec (int type,const struct compat_iovec __user * uvector,unsigned nr_segs,unsigned fast_segs,struct iovec **iov,struct iov_iter *i); + +struct iovec *compat_iovec_import (int type, +const struct compat_iovec __user * uvector, +unsigned int nr_segs,struct iovec_cache *cache, +struct iov_iter *i); +#endif int import_single_range(int type, void __user *buf, size_t len,lib/iov_iter.c +27
-46@@ -1648,69 +1648,50 @@ const void *dup_iter(struct iov_iter *new, struct iov_iter *old, gfp_t flags) }EXPORT_SYMBOL (dup_iter); -/** -* rw_copy_check_uvector() - Copy an array of &struct iovec from userspace -* into the kernel and check that it is valid. +* iovec_import() - Copy an array of &struct iovec from userspace +* into the kernel, check that it is valid, and initialize a new +* &struct iov_iter iterator to access it. * -* @type: One of %CHECK_IOVEC_ONLY, %READ, or %WRITE. +* @type: One of %CHECK_IOVEC_ONLY, %READ or %WRITE. * @uvector: Pointer to the userspace array. * @nr_segs: Number of elements in userspace array. -* @fast_segs: Number of elements in @fast_pointer. -* @fast_pointer: Pointer to (usually small on-stack) kernel array. -* @ret_pointer: (output parameter) Pointer to a variable that will point to -* either @fast_pointer, a newly allocated kernel array, or NULL, -* depending on which array was used. -* -* This function copies an array of &struct iovec of @nr_segs from -* userspace into the kernel and checks that each element is valid (e.g. -* it does not point to a kernel address or cause overflow by being too -* large, etc.). -* -* As an optimization, the caller may provide a pointer to a small -* on-stack array in @fast_pointer, typically %UIO_FASTIOV elements long -* (the size of this array, or 0 if unused, should be given in @fast_segs). -* -* @ret_pointer will always point to the array that was used, so the -* caller must take care not to call kfree() on it e.g. in case the -* @fast_pointer array was used and it was allocated on the stack. +* @fast_segs: Number of elements in @iov. +* @fast_pointer: Pointer to (usually small on-stack) kernel array. +* @i: Pointer to iterator that will be initialized on success. * -* Return: The total number of bytes covered by the iovec array on success -* or a negative error code on error. +* Return: Negative error code on error. +* Success address of iovec array array to free if there were +* more than fast_segs items, NULL otherwise. */ -static ssize_t rw_copy_check_uvector (int type,const struct iovec __user * uvector, -unsigned long nr_segs,unsigned long fast_segs, -struct iovec *fast_pointer, -struct iovec **ret_pointer) +struct iovec *iovec_import (int type,const struct iovec __user * uvector, +unsigned int nr_segs,struct iovec_cache *cache, +struct iov_iter *i) { -unsigned long seg; -ssize_t ret; -struct iovec *iov = fast_pointer; +struct iovec *iov = cache->iov; +struct iovec *iov_kmalloc =NULL ; +unsigned int seg; +size_t count; +int ret;/* * SuS says "The readv() function *may* fail if the iovcnt argument * was less than or equal to 0, or greater than {IOV_MAX}. Linux has -* traditionally returned zero for zero segments, so... +* traditionally returned zero for zero segments. +* No need to optimise... */ -if (nr_segs ==0 ) { - ret =0 ; - goto out; - }/* * First get the "struct iovec" from user memory and * verify all the pointers */ -if (nr_segs >UIO_MAXIOV ) { - ret = -EINVAL ; - goto out; - } -if (nr_segs > fast_segs) { +if (!cache || nr_segs >ARRAY_SIZE (cache->iov)) { +if (nr_segs >UIO_MAXIOV ) +return ERR_PTR (-EINVAL ); iov =kmalloc_array (nr_segs,sizeof (struct iovec ),GFP_KERNEL ); -if (iov ==NULL ) { - ret = -ENOMEM ; - goto out; - } +if (iov ==NULL ) +return ERR_PTR (-ENOMEM ); + iov_kmalloc = iov; }if (copy_from_user (iov, uvector, nr_segs*sizeof (*uvector))) { ret = -EFAULT ;@@ -1726,7 +1707,7 @@ static ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvect* Linux caps all read/write calls to MAX_RW_COUNT, and avoids the * overflow case. */ - ret =0 ; + count =0 ;for (seg =0 ; seg < nr_segs; seg++) {void __user *buf = iov[seg].iov_base;ssize_t len = (ssize_t )iov[seg].iov_len;@@ -1742,16 +1723,21 @@ static ssize_t rw_copy_check_uvector(int type, const struct iovec __user *uvect
lib/iov_iter.c +59
-63ret = -EFAULT ; goto out; } -if (len >MAX_RW_COUNT - ret) { - len =MAX_RW_COUNT - ret; +if (len >MAX_RW_COUNT - count) { + len =MAX_RW_COUNT - count; iov[seg].iov_len = len; } - ret += len; + count += len; } + +iov_iter_init (i, type, iov, nr_segs, count); +return iov_kmalloc; + out: - *ret_pointer = iov; -return ret; +kfree (iov_kmalloc); +return ERR_PTR (ret); } +EXPORT_SYMBOL (iovec_import);/** * import_iovec() - Copy an array of &struct iovec from userspace @@ -1779,57 +1765,47 @@ ssize_t import_iovec(int type, const struct iovec __user * uvector, unsigned nr_segs, unsigned fast_segs, struct iovec **iov, struct iov_iter *i) { - ssize_t n; -struct iovec *p; - n =rw_copy_check_uvector (type, uvector, nr_segs, fast_segs, - *iov, &p); -if (n <0 ) { -if (p != *iov) -kfree (p); + struct iovec *iov_kmalloc; + + iov_kmalloc =iovec_import (type, uvector, nr_segs, + fast_segs >=UIO_FASTIOV ? (void *)*iov :NULL , i); + +if (IS_ERR (iov_kmalloc)) { *iov =NULL ; -return n; +return PTR_ERR (iov_kmalloc); } -iov_iter_init (i, type, p, nr_segs, n); - *iov = p == *iov ?NULL : p; -return n; + + *iov = iov_kmalloc; +return i->count; }EXPORT_SYMBOL (import_iovec);#ifdef CONFIG_COMPAT #include <linux/compat.h> -static ssize_t compat_rw_copy_check_uvector (int type, -const struct compat_iovec __user *uvector,unsigned long nr_segs, -unsigned long fast_segs,struct iovec *fast_pointer, -struct iovec **ret_pointer) +struct iovec *compat_iovec_import (int type, +const struct compat_iovec __user *uvector,unsigned int nr_segs, +struct iovec_cache *cache,struct iov_iter *i) {compat_ssize_t tot_len; -struct iovec *iov = *ret_pointer = fast_pointer; -ssize_t ret =0 ; -int seg; - -/* -* SuS says "The readv() function *may* fail if the iovcnt argument -* was less than or equal to 0, or greater than {IOV_MAX}. Linux has -* traditionally returned zero for zero segments, so... -*/ -if (nr_segs ==0 ) - goto out; - - ret = -EINVAL ; -if (nr_segs >UIO_MAXIOV ) - goto out; -if (nr_segs > fast_segs) { - ret = -ENOMEM ; +struct iovec *iov = cache->iov; +struct iovec *iov_kmalloc =NULL ; +int ret; +unsigned int seg; + +if (!cache || nr_segs >ARRAY_SIZE (cache->iov)) { +if (nr_segs >UIO_MAXIOV ) +return ERR_PTR (-EINVAL ); iov =kmalloc_array (nr_segs,sizeof (struct iovec ),GFP_KERNEL );if (iov ==NULL ) - goto out; +return ERR_PTR (-ENOMEM ); + iov_kmalloc = iov; } - *ret_pointer = iov; - ret = -EFAULT ; -if (!access_ok (uvector, nr_segs*sizeof (*uvector))) +if (!access_ok (uvector, nr_segs*sizeof (*uvector))) { + ret = -EINVAL ; goto out; + }/* * Single unix specification: @@ -1840,18 +1816,19 @@ static ssize_t compat_rw_copy_check_uvector(int type,* no overflow possibility. */ tot_len =0 ; - ret = -EINVAL ;for (seg =0 ; seg < nr_segs; seg++) {compat_uptr_t buf;compat_ssize_t len; -if (__get_user (len, &uvector->iov_len) || -__get_user (buf, &uvector->iov_base)) { +if (__get_user (len, &uvector[seg].iov_len) || +__get_user (buf, &uvector[seg].iov_base)) { ret = -EFAULT ; goto out; } -if (len <0 )/* size_t not fitting in compat_ssize_t .. */ +if (len <0 ) {/* size_t not fitting in compat_ssize_t .. */ + ret = -EINVAL ; goto out; + }if (type >=0 && !access_ok (compat_ptr (buf), len)) { ret = -EFAULT ;@@ -1860,35 +1837,36 @@ static ssize_t compat_rw_copy_check_uvector(int type,if (len >MAX_RW_COUNT - tot_len) len =MAX_RW_COUNT - tot_len; tot_len += len; - iov->iov_base =compat_ptr (buf); - iov->iov_len = (compat_size_t ) len; - uvector++; - iov++; + iov[seg].iov_base =compat_ptr (buf); + iov[seg].iov_len = len; } - ret = tot_len; + +iov_iter_init (i, type, iov, nr_segs, tot_len); +return iov_kmalloc; out: -return ret; +kfree (iov_kmalloc); +return ERR_PTR (ret); } +EXPORT_SYMBOL (compat_iovec_import);ssize_t compat_import_iovec (int type,const struct compat_iovec __user * uvector,unsigned nr_segs,unsigned fast_segs,struct iovec **iov,struct iov_iter *i) { -ssize_t n; -struct iovec *p; - n =compat_rw_copy_check_uvector (type, uvector, nr_segs, fast_segs, - *iov, &p); -if (n <0 ) { -if (p != *iov) -kfree (p); +struct iovec *iov_kmalloc; + + iov_kmalloc =compat_iovec_import (type, uvector, nr_segs, + fast_segs >=UIO_FASTIOV ? (void *)*iov :NULL , i); + +if (IS_ERR (iov_kmalloc)) { *iov =NULL ; -return n; +return PTR_ERR (iov_kmalloc); } -iov_iter_init (i, type, p, nr_segs, n); - *iov = p == *iov ?NULL : p; -return n; + + *iov = iov_kmalloc; +return i->count; }EXPORT_SYMBOL (compat_import_iovec);#endif --
Quoted 1 line
1.8.1.2
-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)