-
Notifications
You must be signed in to change notification settings - Fork 65
Verify CStr CloneToUninit and Index<RangeFrom> safety (Challenge 13) #543
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,6 +36,10 @@ | |
|
|
||
| #![stable(feature = "rust1", since = "1.0.0")] | ||
|
|
||
| use safety::requires; | ||
|
|
||
| #[cfg(kani)] | ||
| use crate::kani; | ||
| use crate::marker::{Destruct, PointeeSized}; | ||
|
|
||
| mod uninit; | ||
|
|
@@ -544,6 +548,7 @@ unsafe impl CloneToUninit for str { | |
| #[unstable(feature = "clone_to_uninit", issue = "126799")] | ||
| unsafe impl CloneToUninit for crate::ffi::CStr { | ||
| #[cfg_attr(debug_assertions, track_caller)] | ||
| #[requires(!dest.is_null())] | ||
| unsafe fn clone_to_uninit(&self, dest: *mut u8) { | ||
| // SAFETY: For now, CStr is just a #[repr(trasnsparent)] [c_char] with some invariants. | ||
| // And we can cast [c_char] to [u8] on all supported platforms (see: to_bytes_with_nul). | ||
|
Comment on lines
550
to
554
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -875,6 +875,7 @@ impl FusedIterator for Bytes<'_> {} | |
| #[unstable(feature = "kani", issue = "none")] | ||
| mod verify { | ||
| use super::*; | ||
| use crate::clone::CloneToUninit; | ||
|
|
||
| // Helper function | ||
| fn arbitrary_cstr(slice: &[u8]) -> &CStr { | ||
|
|
@@ -1096,4 +1097,53 @@ mod verify { | |
| assert_eq!(expected_is_empty, c_str.is_empty()); | ||
| assert!(c_str.is_safe()); | ||
| } | ||
|
|
||
| // ops::Index<ops::RangeFrom<usize>> for CStr | ||
| #[kani::proof] | ||
| #[kani::unwind(33)] | ||
| fn check_index_from() { | ||
| const MAX_SIZE: usize = 32; | ||
| let string: [u8; MAX_SIZE] = kani::any(); | ||
| let slice = kani::slice::any_slice_of_array(&string); | ||
| let c_str = arbitrary_cstr(slice); | ||
|
|
||
| let bytes_with_nul = c_str.to_bytes_with_nul(); | ||
| let idx: usize = kani::any(); | ||
| kani::assume(idx < bytes_with_nul.len()); | ||
|
|
||
| let indexed = &c_str[idx..]; | ||
| assert!(indexed.is_safe()); | ||
| // The indexed result should correspond to the tail of the original bytes | ||
| assert_eq!(indexed.to_bytes_with_nul(), &bytes_with_nul[idx..]); | ||
| } | ||
|
|
||
| // CloneToUninit for CStr | ||
| // MAX_SIZE is kept small to avoid CBMC timeout: the symbolic pointer | ||
| // arithmetic in clone_to_uninit is expensive; 8 bytes is sufficient to | ||
| // cover empty, single-char, and multi-char C strings. | ||
| #[kani::proof] | ||
| #[kani::unwind(9)] | ||
| fn check_clone_to_uninit() { | ||
| const MAX_SIZE: usize = 8; | ||
| let string: [u8; MAX_SIZE] = kani::any(); | ||
| let slice = kani::slice::any_slice_of_array(&string); | ||
| let c_str = arbitrary_cstr(slice); | ||
|
|
||
| let len = c_str.to_bytes_with_nul().len(); | ||
|
|
||
| // Allocate destination buffer (len <= MAX_SIZE since slice.len() <= MAX_SIZE) | ||
| let mut buf = [core::mem::MaybeUninit::<u8>::uninit(); MAX_SIZE]; | ||
| let dest = buf.as_mut_ptr() as *mut u8; | ||
|
|
||
|
Comment on lines
+1132
to
+1137
|
||
| // Safety: dest is non-null (stack allocation), valid for len writes | ||
| unsafe { | ||
| c_str.clone_to_uninit(dest); | ||
| } | ||
|
|
||
| // Verify the cloned bytes form a valid CStr | ||
| let cloned_slice = unsafe { core::slice::from_raw_parts(dest, len) }; | ||
| let cloned_cstr = CStr::from_bytes_with_nul(cloned_slice); | ||
| assert!(cloned_cstr.is_ok()); | ||
|
Comment on lines
+1134
to
+1146
|
||
| assert!(cloned_cstr.unwrap().is_safe()); | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo in comment:
#[repr(trasnsparent)]should be#[repr(transparent)].