thunderbolt: debugfs: Replace get_zeroed_page() with kzalloc()
Subsystems (2)
PATCH 1/1 thunderbolt: debugfs: Replace get_zeroed_page() with kzalloc()
validate_and_copy_from_user() allocates a page to store data from userspace via get_zeroed_page(), and then returns it as a buffer. Neither the function itself nor its callers require struct page access.
This buffer can easily be allocated with kzalloc() as there is nothing special about it that requires going through the page allocator. kzalloc(), which internally reduces to kmalloc() with __GFP_ZERO, provides a better API and kfree() does not need to know the size of the freed object. Additionally it removes the casts of (void *) and (unsigned long) which only obfuscate the code.
Replace get_zeroed_page() with kzalloc() and free_page() with kfree().
Compile-tested only; no USB4 hardware available.
--- drivers/thunderbolt/debugfs.c | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-)
drivers/thunderbolt/debugfs.c +14 -14
@@ -136,13 +136,13 @@ static void *validate_and_copy_from_user(const void __user *user_buf,if (!access_ok (user_buf, *count))return ERR_PTR (-EFAULT ); - buf = (void *)get_zeroed_page (GFP_KERNEL ); + buf =kzalloc (PAGE_SIZE ,GFP_KERNEL );if (!buf)return ERR_PTR (-ENOMEM ); nbytes =min_t (size_t, *count,PAGE_SIZE );if (copy_from_user (buf, user_buf, nbytes)) { -free_page ((unsigned long )buf); +kfree (buf);return ERR_PTR (-EFAULT ); }
@@ -265,7 +265,7 @@ static ssize_t regs_write(struct tb_switch *sw, struct tb_port *port, out:pm_runtime_mark_last_busy (&sw->dev);pm_runtime_put_autosuspend (&sw->dev); -free_page ((unsigned long )buf); +kfree (buf);return ret <0 ? ret : count; }
@@ -406,7 +406,7 @@ static ssize_t port_sb_regs_write(struct file *file, const char __user *user_buf out:pm_runtime_mark_last_busy (&sw->dev);pm_runtime_put_autosuspend (&sw->dev); -free_page ((unsigned long )buf); +kfree (buf);return ret <0 ? ret : count; }
@@ -439,7 +439,7 @@ static ssize_t retimer_sb_regs_write(struct file *file, out:pm_runtime_mark_last_busy (&rt->dev);pm_runtime_put_autosuspend (&rt->dev); -free_page ((unsigned long )buf); +kfree (buf);return ret <0 ? ret : count; }
@@ -652,7 +652,7 @@ margining_ber_level_write(struct file *file, const char __user *user_buf, margining->ber_level = val; out_free: -free_page ((unsigned long )buf); +kfree (buf); out_unlock:mutex_unlock (&tb->lock);
@@ -829,7 +829,7 @@ margining_lanes_write(struct file *file, const char __user *user_buf, } } -free_page ((unsigned long )buf); +kfree (buf);if (lane ==-1 )return -EINVAL ;
@@ -958,7 +958,7 @@ margining_error_counter_write(struct file *file, const char __user *user_buf,else goto err_free; -free_page ((unsigned long )buf); +kfree (buf); scoped_cond_guard(mutex_intr, return -ERESTARTSYS, &tb->lock) {if (!margining->software)
@@ -970,7 +970,7 @@ margining_error_counter_write(struct file *file, const char __user *user_buf,return count; err_free: -free_page ((unsigned long )buf); +kfree (buf);return -EINVAL ; }
@@ -1116,7 +1116,7 @@ static ssize_t margining_mode_write(struct file *file,mutex_unlock (&tb->lock); out_free: -free_page ((unsigned long )buf); +kfree (buf);return ret ? ret : count; }
@@ -1503,7 +1503,7 @@ static ssize_t margining_test_write(struct file *file,mutex_unlock (&tb->lock); out_free: -free_page ((unsigned long )buf); +kfree (buf);return ret ? ret : count; }
@@ -1569,7 +1569,7 @@ static ssize_t margining_margin_write(struct file *file,mutex_unlock (&tb->lock); out_free: -free_page ((unsigned long )buf); +kfree (buf);return ret ? ret : count; }
@@ -1624,7 +1624,7 @@ static ssize_t margining_eye_write(struct file *file, ret = -EINVAL ; } -free_page ((unsigned long )buf); +kfree (buf);return ret ? ret : count; }
@@ -1934,7 +1934,7 @@ static ssize_t counters_write(struct file *file, const char __user *user_buf, out:pm_runtime_mark_last_busy (&sw->dev);pm_runtime_put_autosuspend (&sw->dev); -free_page ((unsigned long )buf); +kfree (buf);return ret <0 ? ret : count; }
Signature · 1 line
2.54.0
Some context I meant to include below the --- and accidentally forgot:
Mike Rapoport is running a broader effort to move allocations that do not need struct page access off the page allocator. He does not seem to be maintaining a tree for it, so landing this via your own tree would be appreciated.
The buffer is kept at PAGE_SIZE to preserve the existing truncation behaviour. If you would prefer it sized to the actual write instead, I can send a v2.
Best regards,
Mahad Ibrahim
Quoted 11 lines · Mahad Ibrahim
validate_and_copy_from_user()allocates a page to store data from userspace viaget_zeroed_page(), and then returns it as a buffer. Neither the function itself nor its callers require struct page access.This buffer can easily be allocated with
kzalloc()as there is nothing special about it that requires going through the page allocator.kzalloc(), which internally reduces tokmalloc()with__GFP_ZERO, provides a better API andkfree()does not need to know the size of the freed object. Additionally it removes the casts of (void *) and (unsigned long) which only obfuscate the code.
Quoted 6 lines
Replace
get_zeroed_page()withkzalloc()andfree_page()withkfree().Compile-tested only; no USB4 hardware available.
Quoted 3 lines
--- drivers/thunderbolt/debugfs.c | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-)
Signature · 2 lines
Sincerely yours, Mike.
Mika Westerberg
AppliedHi,
Quoted 11 lines · Mahad Ibrahim
validate_and_copy_from_user()allocates a page to store data from userspace viaget_zeroed_page(), and then returns it as a buffer. Neither the function itself nor its callers require struct page access.This buffer can easily be allocated with
kzalloc()as there is nothing special about it that requires going through the page allocator.kzalloc(), which internally reduces tokmalloc()with__GFP_ZERO, provides a better API andkfree()does not need to know the size of the freed object. Additionally it removes the casts of (void *) and (unsigned long) which only obfuscate the code.
Quoted 3 lines
Replace
get_zeroed_page()withkzalloc()andfree_page()withkfree().Compile-tested only; no USB4 hardware available.
I tested this on Intel HW and works fine.
Quoted 2 lines
Applied to thunderbolt.git/next with Mike's ack. Thanks!