rust: alloc: add Vec::resize and Vec::truncate
Subsystems (7)
v2 cover rust: alloc: add Vec::resize and Vec::truncate
This patch series implements the Vec::truncate and Vec::resize methods that were needed by the nova driver and removes the corresponding item from their task list
changes in v2:
- updated safety comments
- fixed rustdoc comment spacing
- reworded commit messages to be imperative
- Link to v1: https://lore.kernel.org/rust-for-linux/[email protected]/
Andrew Ballance (3):
rust: alloc: add Vec::truncate method
rust: alloc: add Vec::resize method
gpu: nova-core: remove completed Vec extentions from task list
Documentation/gpu/nova/core/todo.rst | 10 ----- rust/kernel/alloc/kvec.rs | 62 ++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 10 deletions(-)
Signature · 1 line
2.48.1
PATCH v2 1/3 rust: alloc: add Vec::truncate method
implement the equivalent to the std's Vec::truncate on the kernel's Vec type.
--- rust/kernel/alloc/kvec.rs | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+)
rust/kernel/alloc/kvec.rs +36 -0
@@ -452,6 +452,42 @@ pub fn reserve(&mut self, additional: usize, flags: Flags) -> Result<(), AllocErOk (()) } + +/// Shortens the vector, setting the length to `len` and drops the removed values. +/// If `len` is greater than or equal to the current length, this does nothing. +/// +/// This has no effect on the capacity and will not allocate. +/// # Examples +/// +/// ``` +/// let mut v = kernel::kvec![1, 2, 3]?; +/// v.truncate(1); +/// assert_eq!(v.len(), 1); +/// assert_eq!(&v, &[1]); +/// +/// # Ok::<(), Error>(()) +/// ``` +pub fn truncate (&mut self, len:usize ) { +if len >= self.len () { +return ; + } + +let drop_range = len..self.len (); + +// SAFETY: `drop_range` is a subrange of `[0, len)` by the bounds check above. +let ptr: *mut [T ] =unsafe { self.get_unchecked_mut (drop_range) }; + +// SAFETY: +// - this will always shrink the vector because of the above bounds check +// - [`new_len`, `self.len`) will be dropped through the call to `drop_in_place` below +unsafe { self.set_len (len) }; + +// SAFETY: +// - the dropped values are valid `T`s by the type invariant +// - we are allowed to invalidate [`new_len`, `old_len`) because we just changed the +// len, therefore we have exclusive access to [`new_len`, `old_len`) +unsafe { ptr::drop_in_place (ptr) }; + } }impl <T :Clone ,A :Allocator >Vec <T ,A > {
Signature · 1 line
2.48.1
Danilo Krummrich
maintainerRe: [PATCH v2 1/3] rust: alloc: add Vec::truncate method
Quoted 34 lines · Andrew Ballance
implement the equivalent to the std's
Vec::truncateon the kernel's Vec type.Signed-off-by Andrew Ballance <[email protected]>--- rust/kernel/alloc/kvec.rs | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+)rust/kernel/alloc/kvec.rs +18
-0@@ -452,6 +452,42 @@ pub fn reserve(&mut self, additional: usize, flags: Flags) -> Result<(), AllocErOk (()) } + +/// Shortens the vector, setting the length to `len` and drops the removed values. +/// If `len` is greater than or equal to the current length, this does nothing. +/// +/// This has no effect on the capacity and will not allocate. +/// # Examples +/// +/// ``` +/// let mut v = kernel::kvec![1, 2, 3]?; +/// v.truncate(1); +/// assert_eq!(v.len(), 1); +/// assert_eq!(&v, &[1]); +/// +/// # Ok::<(), Error>(()) +/// ``` +pub fn truncate (&mut self, len:usize ) { +if len >= self.len () { +return ;
rust/kernel/alloc/kvec.rs pub fn reserve(&mut self, additional: usize, flags: Flags) -> Result<(), AllocEr · line 482
Quoted 10 lines
rust/kernel/alloc/kvec.rs +10
-0+ } + +let drop_range = len..self.len (); + +// SAFETY: `drop_range` is a subrange of `[0, len)` by the bounds check above. +let ptr: *mut [T ] =unsafe { self.get_unchecked_mut (drop_range) }; + +// SAFETY: +// - this will always shrink the vector because of the above bounds check +// - [`new_len`, `self.len`) will be dropped through the call to `drop_in_place` below
We've just figured out that this part is not needed after all, sorry for the inconvenience. No need to resend for this though, I can remove this line when applying the patch.
Quoted 14 lines
rust/kernel/alloc/kvec.rs +8
-0+unsafe { self.set_len (len) }; + +// SAFETY: +// - the dropped values are valid `T`s by the type invariant +// - we are allowed to invalidate [`new_len`, `old_len`) because we just changed the +// len, therefore we have exclusive access to [`new_len`, `old_len`) +unsafe { ptr::drop_in_place (ptr) }; + } }impl <T :Clone ,A :Allocator >Vec <T ,A > {Signature · 1 line
2.48.1
PATCH v2 2/3 rust: alloc: add Vec::resize method
In reply to Andrew Ballanceimplement the equivalent of the rust std's Vec::resize on the kernel's Vec type.
--- rust/kernel/alloc/kvec.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+)
rust/kernel/alloc/kvec.rs +26 -0
@@ -554,6 +554,32 @@ pub fn from_elem(value: T, n: usize, flags: Flags) -> Result<Self, AllocError> {Ok (v) } + +/// Resizes the [`Vec`] so that `len` is equal to `new_len`. +/// +/// If `new_len` is smaller than `len`, the `Vec` is [`Vec::truncate`]d. +/// If `new_len` is larger, each new slot is filled with clones of `value`. +/// +/// # Examples +/// +/// ``` +/// let mut v = kernel::kvec![1, 2, 3]?; +/// v.resize(1, 42, GFP_KERNEL)?; +/// assert_eq!(&v, &[1]); +/// +/// v.resize(3, 42, GFP_KERNEL)?; +/// assert_eq!(&v, &[1, 42, 42]); +/// +/// # Ok::<(), Error>(()) +/// ``` +pub fn resize (&mut self, new_len:usize , value:T , flags:Flags ) ->Result <(),AllocError > { +if new_len > self.len () { + self.extend_with (new_len - self.len (), value, flags) + }else { + self.truncate (new_len); +Ok (()) + } + } }impl <T ,A >Drop for Vec <T ,A >
Signature · 1 line
2.48.1
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 4 lines · Andrew Ballance
implement the equivalent of the rust std's
Vec::resizeon the kernel's Vec type.Signed-off-by Andrew Ballance <[email protected]>
---
Cheers,
Benno
Quoted 3 lines
--- rust/kernel/alloc/kvec.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+)
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
In reply to Andrew BallanceQuoted 33 lines · Andrew Ballance
implement the equivalent of the rust std's
Vec::resizeon the kernel's Vec type.Signed-off-by Andrew Ballance <[email protected]>--- rust/kernel/alloc/kvec.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+)rust/kernel/alloc/kvec.rs +16
-0@@ -554,6 +554,32 @@ pub fn from_elem(value: T, n: usize, flags: Flags) -> Result<Self, AllocError> {Ok (v) } + +/// Resizes the [`Vec`] so that `len` is equal to `new_len`. +/// +/// If `new_len` is smaller than `len`, the `Vec` is [`Vec::truncate`]d. +/// If `new_len` is larger, each new slot is filled with clones of `value`. +/// +/// # Examples +/// +/// ``` +/// let mut v = kernel::kvec![1, 2, 3]?; +/// v.resize(1, 42, GFP_KERNEL)?; +/// assert_eq!(&v, &[1]); +/// +/// v.resize(3, 42, GFP_KERNEL)?; +/// assert_eq!(&v, &[1, 42, 42]); +///
rust/kernel/alloc/kvec.rs pub fn from_elem(value: T, n: usize, flags: Flags) -> Result<Self, AllocError> { · line 582
Quoted 10 lines
rust/kernel/alloc/kvec.rs +10
-0+/// # Ok::<(), Error>(()) +/// ``` +pub fn resize (&mut self, new_len:usize , value:T , flags:Flags ) ->Result <(),AllocError > { +if new_len > self.len () { + self.extend_with (new_len - self.len (), value, flags) + }else { + self.truncate (new_len); +Ok (()) + } + }
You can avoid underflow checking in debug builds by using checked_sub:
match new_len.checked_sub(self.len()) {
Some(n) => self.extend_with(n, value, flags),
None => {
self.truncate(new_len);
Ok(())
}
}Quoted 7 lines
rust/kernel/alloc/kvec.rs +0
-1}impl <T ,A >Drop for Vec <T ,A > --2.48.1
Either way:
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 11 lines · Tamir Duberstein
rust/kernel/alloc/kvec.rs pub fn from_elem(value: T, n: usize, flags: Flags) -> Result<Self, AllocError> { · line 582
Quoted 8 lines · Andrew Ballance
rust/kernel/alloc/kvec.rs +8
-0+pub fn resize (&mut self, new_len:usize , value:T , flags:Flags ) ->Result <(),AllocError > { +if new_len > self.len () { + self.extend_with (new_len - self.len (), value, flags) + }else { + self.truncate (new_len); +Ok (()) + } + }
Quoted 1 line
You can avoid underflow checking in debug builds by using
checked_sub:
checked_sub doesn't only avoid underflow in debug builds, but rather in all builds. But the code below is a good suggestion.
---
Cheers,
Benno
Quoted 19 lines
match new_len.checked_sub(self.len()) { Some(n) => self.extend_with(n, value, flags), None => { self.truncate(new_len); Ok(()) } }Quoted 7 lines
}
impl<T, A> Drop for Vec<T, A>
--
2.48.1Either way:
Reviewed-by Tamir Duberstein <[email protected]>
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 13 lines · Benno Lossin
Quoted 11 lines · Tamir Duberstein
Quoted 8 lines · Andrew Ballance
rust/kernel/alloc/kvec.rs +8
-0+pub fn resize (&mut self, new_len:usize , value:T , flags:Flags ) ->Result <(),AllocError > { +if new_len > self.len () { + self.extend_with (new_len - self.len (), value, flags) + }else { + self.truncate (new_len); +Ok (()) + } + }
Quoted 4 lines
Quoted 1 line
You can avoid underflow checking in debug builds by using
checked_sub:
checked_subdoesn't only avoid underflow in debug builds, but rather in all builds. But the code below is a good suggestion.
Yes, I know :)
I included that language because the underflow check is likely optimized away in release builds.
Tamir
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 16 lines · Tamir Duberstein
Quoted 15 lines · Benno Lossin
Quoted 12 lines · Tamir Duberstein
rust/kernel/alloc/kvec.rs pub fn from_elem(value: T, n: usize, flags: Flags) -> Result<Self, AllocError> { · line 582
Quoted 8 lines · Andrew Ballance
rust/kernel/alloc/kvec.rs +8
-0+pub fn resize (&mut self, new_len:usize , value:T , flags:Flags ) ->Result <(),AllocError > { +if new_len > self.len () { + self.extend_with (new_len - self.len (), value, flags) + }else { + self.truncate (new_len); +Ok (()) + } + }You can avoid underflow checking in debug builds by using
checked_sub:
Quoted 7 lines
Quoted 2 lines
checked_subdoesn't only avoid underflow in debug builds, but rather in all builds. But the code below is a good suggestion.Yes, I know :)
I included that language because the underflow check is likely optimized away in release builds.
If the function is inlined and the compiler can argue that new_len > self.len(), then yes, but otherwise I'm pretty sure it won't be optimized away.
Also if it is optimized away, then the check was still "executed", so I find it a bit misleading to say "in debug builds" (making it sound like it wouldn't do it in non-debug builds).
---
Cheers,
Benno
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 26 lines · Benno Lossin
Quoted 16 lines · Tamir Duberstein
Quoted 15 lines · Benno Lossin
Quoted 12 lines · Tamir Duberstein
rust/kernel/alloc/kvec.rs pub fn from_elem(value: T, n: usize, flags: Flags) -> Result<Self, AllocError> { · line 582
Quoted 8 lines · Andrew Ballance
rust/kernel/alloc/kvec.rs +8
-0+pub fn resize (&mut self, new_len:usize , value:T , flags:Flags ) ->Result <(),AllocError > { +if new_len > self.len () { + self.extend_with (new_len - self.len (), value, flags) + }else { + self.truncate (new_len); +Ok (()) + } + }You can avoid underflow checking in debug builds by using
checked_sub:Quoted 7 lines
Quoted 2 lines
checked_subdoesn't only avoid underflow in debug builds, but rather in all builds. But the code below is a good suggestion.Yes, I know :)
I included that language because the underflow check is likely optimized away in release builds.
Quoted 7 lines
If the function is inlined and the compiler can argue that
new_len > self.len(), then yes, but otherwise I'm pretty sure it won't be optimized away.Also if it is optimized away, then the check was still "executed", so I find it a bit misleading to say "in debug builds" (making it sound like it wouldn't do it in non-debug builds).
If we're talking about the same thing then I think we're both wrong and the correct phrasing would have been: "you can avoid underflow checking when CONFIG_RUST_OVERFLOW_CHECKS=y by using checked_sub". I was referring to the underflow check implicit in new_len - self.len().
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 6 lines · Tamir Duberstein
If we're talking about the same thing then I think we're both wrong and the correct phrasing would have been: "you can avoid underflow checking when
CONFIG_RUST_OVERFLOW_CHECKS=yby usingchecked_sub". I was referring to the underflow check implicit innew_len - self.len().
checked_sub always checks (if not optimized away). The config option is about the implicit one.
Do you mean avoiding panics?
Cheers,
Miguel
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 9 lines · Miguel Ojeda
Quoted 6 lines · Tamir Duberstein
If we're talking about the same thing then I think we're both wrong and the correct phrasing would have been: "you can avoid underflow checking when
CONFIG_RUST_OVERFLOW_CHECKS=yby usingchecked_sub". I was referring to the underflow check implicit innew_len - self.len().
Quoted 4 lines
checked_subalways checks (if not optimized away). The config option is about the implicit one.Do you mean avoiding panics?
No, I meant avoiding the check. The existing code already explicitly checks new_len > self.len() before evaluating new_len - self.len(). This means the check occurs twice. checked_sub reduces the number of checks by 1. Perhaps my wording could have been clearer ("avoid *an* underflow check").
Tamir
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 6 lines · Tamir Duberstein
No, I meant avoiding the check. The existing code already explicitly checks
new_len > self.len()before evaluatingnew_len - self.len(). This means the check occurs twice.checked_subreduces the number of checks by 1. Perhaps my wording could have been clearer ("avoid *an* underflow check").
Ah, you mean in the function you suggested, I see.
I think it they all may compile down to the same thing, whether overflows checks are enabled or not, and whether the version in the patch or checked_sub is used or not. At least in a quick Compiler Explorer test it seems so, but I didn't check in an actual kernel build.
The implicit check is gated behind the other one, so that one can be removed, even if values are unknown -- we always have optimizations enabled, even under "debug" builds (assuming "debug" means overflow checking enabled).
Cheers,
Miguel
Re: [PATCH v2 2/3] rust: alloc: add Vec::resize method
Quoted 17 lines · Miguel Ojeda
Quoted 6 lines · Tamir Duberstein
No, I meant avoiding the check. The existing code already explicitly checks
new_len > self.len()before evaluatingnew_len - self.len(). This means the check occurs twice.checked_subreduces the number of checks by 1. Perhaps my wording could have been clearer ("avoid *an* underflow check").Ah, you mean in the function you suggested, I see.
I think it they all may compile down to the same thing, whether overflows checks are enabled or not, and whether the version in the patch or
checked_subis used or not. At least in a quick Compiler Explorer test it seems so, but I didn't check in an actual kernel build.
Quoted 4 lines
The implicit check is gated behind the other one, so that one can be removed, even if values are unknown -- we always have optimizations enabled, even under "debug" builds (assuming "debug" means overflow checking enabled).
Yeah, this elision is what I was trying to allude to in the original wording. I still think the suggested code is simpler, but gave my RB either way.
PATCH v2 3/3 gpu: nova-core: remove completed Vec extentions from task list
In reply to Andrew BallanceThe requested Vec methods have been implemented thus, removes the completed item from the nova task list
--- Documentation/gpu/nova/core/todo.rst | 10 ---------- 1 file changed, 10 deletions(-)
Documentation/gpu/nova/core/todo.rst +0 -10
@@ -190,16 +190,6 @@ Rust abstraction for debugfs APIs. | Reference: Export GSP log buffers | Complexity: Intermediate -Vec extensions --------------- - -Implement ``Vec::truncate`` and ``Vec::resize``. - -Currently this is used for some experimental code to parse the vBIOS. - -| Reference vBIOS support -| Complexity: Beginner - GPU (general) =============
Signature · 1 line
2.48.1
Quoted 10 lines · Andrew Ballance
This patch series implements the
Vec::truncateandVec::resizemethods that were needed by the nova driver and removes the corresponding item from their task listchanges in v2:
- updated safety comments
- fixed rustdoc comment spacing
- reworded commit messages to be imperative
- Link to v1: https://lore.kernel.org/rust-for-linux/[email protected]/
Quoted 3 lines
Andrew Ballance (3):
rust: alloc: addVec::truncatemethod
rust: alloc: addVec::resizemethod
With the following changes, applied to rust/alloc-next, thanks!
- Rewrote safety comment of set_len().
- Use checked_sub(), as suggested by Tamir.
Quoted 1 line
gpu: nova-core: remove completed Vec extentions from task list
Applied to nova-next, thanks!
Quoted 4 lines
Documentation/gpu/nova/core/todo.rst | 10 ----- rust/kernel/alloc/kvec.rs | 62 ++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 10 deletions(-)