iio:kfifo: Protect against concurrent access from userspace
PATCH 1/3 iio:kfifo: Protect against concurrent access from userspace
It is possible for userspace to concurrently access the buffer from multiple threads or processes. To avoid corruption of the internal state of the buffer we need to add proper locking. It is possible for multiple processes to try to read from the buffer concurrently and it is also possible that one process causes a buffer re-allocation while a different process still access the buffer. Both can be fixed by protecting the calls to kfifo_to_user() and kfifo_alloc() by the same mutex. In iio_read_first_n_kfifo() we also use kfifo_recsize() instead of the buffers bytes_per_datum to avoid a race that can happen if bytes_per_datum has been changed, but the buffer has not been reallocated yet.
Note that all access to the buffer from within the kernel is already properly synchronized, so there is no need for extra locking in iio_store_to_kfifo().
--- drivers/iio/kfifo_buf.c | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-)
drivers/iio/kfifo_buf.c +16 -5
@@ -12,6 +12,7 @@struct iio_kfifo {struct iio_buffer buffer;struct kfifo kf; +struct mutex user_lock;int update_needed; };
@@ -34,10 +35,12 @@ static int iio_request_update_kfifo(struct iio_buffer *r)if (!buf->update_needed) goto error_ret; +mutex_lock (&buf->user_lock);kfifo_free (&buf->kf); ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, buf->buffer.length); r->stufftoread = false; +mutex_unlock (&buf->user_lock); error_ret:return ret; }
@@ -114,12 +117,13 @@ static int iio_read_first_n_kfifo(struct iio_buffer *r,int ret, copied;struct iio_kfifo *kf =iio_to_kfifo (r); -if (n < r->bytes_per_datum || r->bytes_per_datum ==0 ) -return -EINVAL ; +if (mutex_lock_interruptible (&kf->user_lock)) +return -ERESTARTSYS ; - ret =kfifo_to_user (&kf->kf, buf, n, &copied); -if (ret <0 ) -return ret; +if (!kfifo_initialized (&kf->kf) || n <kfifo_esize (&kf->kf)) + ret = -EINVAL ; +else + ret =kfifo_to_user (&kf->kf, buf, n, &copied);if (kfifo_is_empty (&kf->kf)) r->stufftoread = false;
@@ -127,11 +131,17 @@ static int iio_read_first_n_kfifo(struct iio_buffer *r,if (!kfifo_is_empty (&kf->kf)) r->stufftoread = true; +mutex_unlock (&kf->user_lock); +if (ret <0 ) +return ret; +return copied; }static void iio_kfifo_buffer_release (struct iio_buffer *buffer) { +struct iio_kfifo *kf =iio_to_kfifo (buffer); +mutex_destroy (&kf->user_lock);kfree (iio_to_kfifo (buffer)); }
@@ -158,6 +168,7 @@ struct iio_buffer *iio_kfifo_allocate(struct iio_dev *indio_dev) kf->buffer.attrs = &iio_kfifo_attribute_group; kf->buffer.access = &kfifo_access_funcs; kf->buffer.length =2 ; +mutex_init (&kf->user_lock);return &kf->buffer; }EXPORT_SYMBOL (iio_kfifo_allocate);
Signature · 1 line
1.8.0
PATCH 2/3 iio:kfifo: Empty buffer on update
The kfifo's request_update callback will free the current buffer and allocate a new one if the size has changed. This will remove any samples that might still be left in the buffer. If the size has not changed the buffer content is left untouched though. This is a bit inconsistent and might cause an application to see data from a previous capture. This patch inserts a call to kfifo_reset_out() when the size did not change. This makes sure that any pending samples are removed from the buffer.
Note, due to a different bug the buffer is currently always re-allocated, even if the size did not change. So this patch will not change the behavior. In the next patch the bug will be fixed and this patch makes sure that the current behavior is kept.
--- drivers/iio/kfifo_buf.c | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-)
drivers/iio/kfifo_buf.c +7 -5
@@ -33,15 +33,17 @@ static int iio_request_update_kfifo(struct iio_buffer *r)int ret =0 ;struct iio_kfifo *buf =iio_to_kfifo (r); -if (!buf->update_needed) - goto error_ret;mutex_lock (&buf->user_lock); -kfifo_free (&buf->kf); - ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, +if (!buf->update_needed) { +kfifo_reset_out (&buf->kf); + }else { +kfifo_free (&buf->kf); + ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, buf->buffer.length); + } r->stufftoread = false;mutex_unlock (&buf->user_lock); -error_ret: +return ret; }
Signature · 1 line
1.8.0
Jonathan Cameron
maintainerRe: [PATCH 2/3] iio:kfifo: Empty buffer on update
Quoted 8 lines · Lars-Peter Clausen
The kfifo's
request_updatecallback will free the current buffer and allocate a new one if the size has changed. This will remove any samples that might still be left in the buffer. If the size has not changed the buffer content is left untouched though. This is a bit inconsistent and might cause an application to see data from a previous capture. This patch inserts a call tokfifo_reset_out()when the size did not change. This makes sure that any pending samples are removed from the buffer.
Quoted 6 lines
Note, due to a different bug the buffer is currently always re-allocated, even if the size did not change. So this patch will not change the behavior. In the next patch the bug will be fixed and this patch makes sure that the current behavior is kept.
Signed-off-by Lars-Peter Clausen <[email protected]>
Just a little preference on ordering in this one...
Quoted 9 lines
--- drivers/iio/kfifo_buf.c | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-)drivers/iio/kfifo_buf.c +0
-0
drivers/iio/kfifo_buf.c static int iio_request_update_kfifo(struct iio_buffer *r) · line 40
Quoted 8 lines
drivers/iio/kfifo_buf.c +0
-4@@ -33,15 +33,17 @@ static int iio_request_update_kfifo(struct iio_buffer *r)int ret =0 ;struct iio_kfifo *buf =iio_to_kfifo (r); -if (!buf->update_needed) - goto error_ret;mutex_lock (&buf->user_lock); -kfifo_free (&buf->kf); - ret = __iio_allocate_kfifo(buf, buf->buffer.bytes_per_datum,
Would you mind flipping the logic on this? Feels more logical to me (slightly) to have
if (buf->update_needed) {
...
} else {
kfifo_reset_out(..)
}Quoted 15 lines
drivers/iio/kfifo_buf.c +7
-1+if (!buf->update_needed) { +kfifo_reset_out (&buf->kf); + }else { +kfifo_free (&buf->kf); + ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, buf->buffer.length); + } r->stufftoread = false;mutex_unlock (&buf->user_lock); -error_ret: +return ret; }
PATCH 3/3 iio:kfifo: Set update_needed to false after allocating a new buffer
In reply to Lars-Peter Clausenupdate_needed is used to decide whether the kfifo buffer needs to be re-allocated. It is set to true whenever the size of the buffer is changed. It is never set to false though, causing the buffer to always be re-allocated. Setting update_needed to false after the new buffer has been allocated fixes the problem.
--- drivers/iio/kfifo_buf.c | 1 + 1 file changed, 1 insertion(+)
drivers/iio/kfifo_buf.c +1 -0
@@ -40,6 +40,7 @@ static int iio_request_update_kfifo(struct iio_buffer *r)kfifo_free (&buf->kf); ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, buf->buffer.length); + buf->update_needed = false; } r->stufftoread = false;mutex_unlock (&buf->user_lock);
Signature · 1 line
1.8.0
Jonathan Cameron
maintainerRe: [PATCH 3/3] iio:kfifo: Set update_needed to false after allocating a new buffer
Quoted 7 lines · Lars-Peter Clausen
update_neededis used to decide whether the kfifo buffer needs to be re-allocated. It is set to true whenever the size of the buffer is changed. It is never set to false though, causing the buffer to always be re-allocated. Settingupdate_neededto false after the new buffer has been allocated fixes the problem.Signed-off-by Lars-Peter Clausen <[email protected]>
A big whoopsy on this one. Well spotted ;)
Quoted 17 lines
--- drivers/iio/kfifo_buf.c | 1 + 1 file changed, 1 insertion(+)drivers/iio/kfifo_buf.c +1
-0@@ -40,6 +40,7 @@ static int iio_request_update_kfifo(struct iio_buffer *r)kfifo_free (&buf->kf); ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, buf->buffer.length); + buf->update_needed = false; } r->stufftoread = false;mutex_unlock (&buf->user_lock);
Jonathan Cameron
maintainerQuoted 10 lines · Lars-Peter Clausen
It is possible for userspace to concurrently access the buffer from multiple threads or processes. To avoid corruption of the internal state of the buffer we need to add proper locking. It is possible for multiple processes to try to read from the buffer concurrently and it is also possible that one process causes a buffer re-allocation while a different process still access the buffer. Both can be fixed by protecting the calls to
kfifo_to_user()andkfifo_alloc()by the same mutex. Iniio_read_first_n_kfifo()we also usekfifo_recsize()instead of the buffersbytes_per_datumto avoid a race that can happen ifbytes_per_datumhas been changed, but the buffer has not been reallocated yet.
Quoted 4 lines
Note that all access to the buffer from within the kernel is already properly synchronized, so there is no need for extra locking in
iio_store_to_kfifo().Signed-off-by Lars-Peter Clausen <[email protected]>
One nitpick.
Amazing number of errors due to my having not thought all of this stuff through thoroughly enough. Oops and thanks for clearing it up!
Jonathan
Quoted 54 lines
--- drivers/iio/kfifo_buf.c | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-)drivers/iio/kfifo_buf.c +11
-5@@ -12,6 +12,7 @@struct iio_kfifo {struct iio_buffer buffer;struct kfifo kf; +struct mutex user_lock;int update_needed; };@@ -34,10 +35,12 @@ static int iio_request_update_kfifo(struct iio_buffer *r)if (!buf->update_needed) goto error_ret; +mutex_lock (&buf->user_lock);kfifo_free (&buf->kf); ret =__iio_allocate_kfifo (buf, buf->buffer.bytes_per_datum, buf->buffer.length); r->stufftoread = false; +mutex_unlock (&buf->user_lock); error_ret:return ret; }@@ -114,12 +117,13 @@ static int iio_read_first_n_kfifo(struct iio_buffer *r,int ret, copied;struct iio_kfifo *kf =iio_to_kfifo (r); -if (n < r->bytes_per_datum || r->bytes_per_datum ==0 ) -return -EINVAL ; +if (mutex_lock_interruptible (&kf->user_lock)) +return -ERESTARTSYS ; - ret =kfifo_to_user (&kf->kf, buf, n, &copied); -if (ret <0 ) -return ret; +if (!kfifo_initialized (&kf->kf) || n <kfifo_esize (&kf->kf)) + ret = -EINVAL ; +else + ret =kfifo_to_user (&kf->kf, buf, n, &copied);if (kfifo_is_empty (&kf->kf)) r->stufftoread = false;@@ -127,11 +131,17 @@ static int iio_read_first_n_kfifo(struct iio_buffer *r,if (!kfifo_is_empty (&kf->kf)) r->stufftoread = true; +mutex_unlock (&kf->user_lock); +if (ret <0 )
drivers/iio/kfifo_buf.c static int iio_read_first_n_kfifo(struct iio_buffer *r, · line 145
Quoted 10 lines
drivers/iio/kfifo_buf.c +4
-0+return ret; +return copied; }static void iio_kfifo_buffer_release (struct iio_buffer *buffer) { +struct iio_kfifo *kf =iio_to_kfifo (buffer); +mutex_destroy (&kf->user_lock);kfree (iio_to_kfifo (buffer));
Given you have the pointer passed to this kfree available, would be nice to use it for that as well.
Quoted 11 lines
drivers/iio/kfifo_buf.c +1
-0}@@ -158,6 +168,7 @@ struct iio_buffer *iio_kfifo_allocate(struct iio_dev *indio_dev) kf->buffer.attrs = &iio_kfifo_attribute_group; kf->buffer.access = &kfifo_access_funcs; kf->buffer.length =2 ; +mutex_init (&kf->user_lock);return &kf->buffer; }EXPORT_SYMBOL (iio_kfifo_allocate);