rust: re-export `unsafe_precondition_assert!` and use in cpu module
Subsystems (2)
v2 cover rust: re-export `unsafe_precondition_assert!` and use in cpu module
This series consists of two patches that together re-export unsafe_precondition_assert! macro from the prelude and use it in the cpu module.
---
Changes in v2:
- Split into two patches
- Add new patch to re-export unsafe_precondition_assert! from the prelude.
- Fix message formatting and copy-paste error.
- Link to v1: https://lore.kernel.org/rust-for-linux/[email protected]/
---
Ritvik Gupta (2):
rust: prelude: re-export unsafe_precondition_assert!
rust: cpu: use unsafe_precondition_assert!
rust/kernel/cpu.rs | 22 +++++++++++++++++----- rust/kernel/prelude.rs | 1 + 2 files changed, 18 insertions(+), 5 deletions(-)
Signature · 1 line
2.54.0
PATCH v2 1/2 rust: prelude: re-export `unsafe_precondition_assert!`
Re-export unsafe_precondition_assert! so the users can import the macro directly via kernel::prelude::* instead of kernel::safety::unsafe_precondition_assert.
--- rust/kernel/prelude.rs | 1 + 1 file changed, 1 insertion(+)
rust/kernel/prelude.rs +1 -0
@@ -101,6 +101,7 @@ try_init, try_pin_init, uaccess::UserPtr, + unsafe_precondition_assert, ThisModule, // };
Signature · 1 line
2.54.0
PATCH v2 2/2 rust: cpu: use `unsafe_precondition_assert!`
In reply to Ritvik GuptaReplace debug_assert! invocations with unsafe_precondition_assert! in from_i32_unchecked and from_u32_unchecked unsafe functions.
--- rust/kernel/cpu.rs | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-)
rust/kernel/cpu.rs +17 -5
@@ -4,7 +4,7 @@//! //! C header: [`include/linux/cpu.h`](srctree/include/linux/cpu.h) -use crate ::{bindings, device::Device , error::Result , prelude::ENODEV }; +use crate ::{bindings, device::Device , error::Result , prelude::*};/// Returns the maximum number of possible CPUs in the current system configuration. #[inline]
@@ -54,8 +54,14 @@ impl CpuId {/// The caller must ensure that `id` is a valid CPU ID (i.e., `0 <= id < nr_cpu_ids()`). #[inline] pub unsafe fn from_i32_unchecked (id:i32 ) ->Self { -debug_assert! (id >=0 ); -debug_assert! ((idas u32 ) <nr_cpu_ids ()); +unsafe_precondition_assert! ( + id >=0 , +"`CpuId::from_i32_unchecked` requires a non-negative `id`" + ); +unsafe_precondition_assert! ( + (idas u32 ) <nr_cpu_ids (), +"`CpuId::from_i32_unchecked` requires a valid `id` (i.e., `0 <= id < nr_cpu_ids()`)" + );// INVARIANT: The function safety guarantees `id` is a valid CPU id. Self (idas u32 )
@@ -78,10 +84,16 @@ pub fn from_i32(id: i32) -> Option<Self> {/// The caller must ensure that `id` is a valid CPU ID (i.e., `0 <= id < nr_cpu_ids()`). #[inline] pub unsafe fn from_u32_unchecked (id:u32 ) ->Self { -debug_assert! (id <nr_cpu_ids ()); +unsafe_precondition_assert! ( + id <nr_cpu_ids (), +"`CpuId::from_u32_unchecked` requires a valid `id` (i.e., `0 <= id < nr_cpu_ids()`)" + );// Ensure the `id` fits in an [`i32`] as it's also representable that way. -debug_assert! (id <=i32 ::MAX as u32 ); +unsafe_precondition_assert! ( + id <=i32 ::MAX as u32 , +"`CpuId::from_u32_unchecked` requires the `id` to not overflow `i32::MAX`" + );// INVARIANT: The function safety guarantees `id` is a valid CPU id. Self (id)
Signature · 1 line
2.54.0
Re: [PATCH v2 2/2] rust: cpu: use `unsafe_precondition_assert!`
Quoted 4 lines · Ritvik Gupta
Replace
debug_assert!invocations withunsafe_precondition_assert!infrom_i32_uncheckedandfrom_u32_uncheckedunsafe functions.
The commit message doesn't mention why the messages were added -- I asked for it because I am not sure if it is worth providing a message for each assertion, especially since the original code decided to avoid it, i.e. the change to the new macro is good on its own, regardless of the messages.
rust/kernel/cpu.rs line 7
Quoted 2 lines
rust/kernel/cpu.rs +1
-1-use crate ::{bindings, device::Device , error::Result , prelude::ENODEV }; +use crate ::{bindings, device::Device , error::Result , prelude::*};
By the way, we could remove error::Result from the list since we have the entire prelude now, and also take the chance to use the new style:
https://docs.kernel.org/rust/coding-guidelines.html#imports
But maybe wait to see if the maintainers have other feedback before v3.
Thanks!
Cheers,
Miguel
Re: [PATCH v2 2/2] rust: cpu: use `unsafe_precondition_assert!`
Quoted 6 lines · Miguel Ojeda
Quoted 4 lines · Ritvik Gupta
Replace
debug_assert!invocations withunsafe_precondition_assert!infrom_i32_uncheckedandfrom_u32_uncheckedunsafe functions.
Quoted 6 lines
The commit message doesn't mention why the messages were added -- I asked for it because I am not sure if it is worth providing a message for each assertion, especially since the original code decided to avoid it, i.e. the change to the new macro is good on its own, regardless of the messages.
Actually, I added messages from UX standpoint, as having explicit failure reason is helpful for debugging, when an assertion is hit.
I can update the commit message to clarify this, or remove it if maintainers prefer keeping it as is.
Quoted 9 lines
rust/kernel/cpu.rs line 7
Quoted 2 lines
rust/kernel/cpu.rs +1
-1-use crate ::{bindings, device::Device , error::Result , prelude::ENODEV }; +use crate ::{bindings, device::Device , error::Result , prelude::*};By the way, we could remove
error::Resultfrom the list since we have the entire prelude now, and also take the chance to use the new style:
Sure, will remove error::Result and use vertical-import style.
Quoted 6 lines
But maybe wait to see if the maintainers have other feedback before v3.
Thanks!
Cheers,
Miguel
Yeah, will wait for some time.
Thanks for your feedback :)