Skip to content

Add contracts for NonZero::from_mut_unchecked #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 15, 2025
Merged

Add contracts for NonZero::from_mut_unchecked #345

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
196da12
Add contracts for NonZero::from_mut_unchecked
tautschnig Apr 29, 2025
e160d11
Merge remote-tracking branch 'origin/main' into from_mut_unchecked
tautschnig Jul 10, 2025
363984b
Fix lookup
tautschnig Jul 10, 2025
3f6b2e1
Fmt
tautschnig Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions library/core/src/num/nonzero.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,12 @@ where
#[must_use]
#[inline]
#[track_caller]
#[requires({
let size = core::mem::size_of::<T>();
let ptr = n as *const T as *const u8;
let slice = unsafe { core::slice::from_raw_parts(ptr, size) };
!slice.iter().all(|&byte| byte == 0)
})]
pub unsafe fn from_mut_unchecked(n: &mut T) -> &mut Self {
match Self::from_mut(n) {
Some(n) => n,
Expand Down Expand Up @@ -2395,6 +2401,80 @@ mod verify {
nonzero_check!(u128, core::num::NonZeroU128, nonzero_check_new_unchecked_for_u128);
nonzero_check!(usize, core::num::NonZeroUsize, nonzero_check_new_unchecked_for_usize);

macro_rules! nonzero_check_from_mut_unchecked {
($t:ty, $nonzero_type:ty, $harness_name:ident) => {
#[kani::proof_for_contract(NonZero::<$t>::from_mut_unchecked)]
pub fn $harness_name() {
let mut x: $t = kani::any();
unsafe {
<$nonzero_type>::from_mut_unchecked(&mut x);
}
}
};
}

// Generate harnesses for multiple types
nonzero_check_from_mut_unchecked!(
i8,
core::num::NonZeroI8,
nonzero_check_from_mut_unchecked_i8
);
nonzero_check_from_mut_unchecked!(
i16,
core::num::NonZeroI16,
nonzero_check_from_mut_unchecked_i16
);
nonzero_check_from_mut_unchecked!(
i32,
core::num::NonZeroI32,
nonzero_check_from_mut_unchecked_i32
);
nonzero_check_from_mut_unchecked!(
i64,
core::num::NonZeroI64,
nonzero_check_from_mut_unchecked_i64
);
nonzero_check_from_mut_unchecked!(
i128,
core::num::NonZeroI128,
nonzero_check_from_mut_unchecked_i128
);
nonzero_check_from_mut_unchecked!(
isize,
core::num::NonZeroIsize,
nonzero_check_from_mut_unchecked_isize
);
nonzero_check_from_mut_unchecked!(
u8,
core::num::NonZeroU8,
nonzero_check_from_mut_unchecked_u8
);
nonzero_check_from_mut_unchecked!(
u16,
core::num::NonZeroU16,
nonzero_check_from_mut_unchecked_u16
);
nonzero_check_from_mut_unchecked!(
u32,
core::num::NonZeroU32,
nonzero_check_from_mut_unchecked_u32
);
nonzero_check_from_mut_unchecked!(
u64,
core::num::NonZeroU64,
nonzero_check_from_mut_unchecked_u64
);
nonzero_check_from_mut_unchecked!(
u128,
core::num::NonZeroU128,
nonzero_check_from_mut_unchecked_u128
);
nonzero_check_from_mut_unchecked!(
usize,
core::num::NonZeroUsize,
nonzero_check_from_mut_unchecked_usize
);

macro_rules! nonzero_check_cmp {
($nonzero_type:ty, $nonzero_check_cmp_for:ident) => {
#[kani::proof]
Expand Down
Loading