Skip to content
Closed
Changes from all commits
Commits
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
55 changes: 55 additions & 0 deletions tests/pass/c_str_clone_into_alloc_error.rs

@RalfJung RalfJung Jul 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • See my comment in your previous PR -- the test should contain references to the issue(s) it is about
  • Since this tests the standard library, not Miri, then if we must have this test here (do we?), it should be in a folder. Maybe call it lib?

View changes since the review

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add the issue references

On the location: I originally wrote this as a library/alloctests test, but a native (non-Miri) alloctests run builds with -C prefer-dynamic, so the #[global_allocator] in the test binary doesn't intercept the reallocation inside CString::clone_into (which lives in libstd). As a result, the test no longer reproduces the bug - I verified this. It only works when the allocator is intercepted, i.e. under Miri.

So if it lives in library/alloctests, it would need to be Miri-only (e.g. #[cfg_attr(not(miri), ignore)]) and rely on the liballoc-under-Miri CI run. Would you prefer that, or should I keep it here under tests/pass/lib/? (oli-obk suggested moving it here from rust-lang/rust#158763)

@RalfJung RalfJung Jul 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a bunch of tests in library/* that are mainly for Miri. They also run as regular tests, nothing wrong with that. So no need to make them not(miri). They only really test what the need to test under Miri, which is fine -- there can be a comment explaining that.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense - I'll move it to library/alloctests. I'll drop the assert that requires the unwind (so it passes as a normal test, where the allocator can't intercept libstd) and keep the check that the target is still a valid CString, with a comment that the failure path only really runs under Miri. Plus the issue references. I'll open that against rust-lang/rust and close this PR.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved it locally and verified: passes as a regular test, and under ./x miri library/alloctests the allocator fires and it catches the bug.

One thing before I open the PR: the x86_64-gnu-miri job runs liballoc with --test-args notest, so as far as I can tell this test would compile under Miri in CI but not run there - the only CI run would be the trivial native one. Is that the coverage you intended, or would you rather keep it as a Miri test (it ran across the full matrix here), or wire it into CI differently?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is another job, something with gnu-aux, that runs this file.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll drop the assert that requires the unwind

If it's useful you can also keep that under if cfg!(miri). Just run as much as possible also natively. :)

Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
//@compile-flags: -Zmiri-ignore-leaks
#![feature(alloc_error_hook)]

use std::alloc::{GlobalAlloc, Layout, System, set_alloc_error_hook};
use std::ffi::CString;
use std::panic::{self, AssertUnwindSafe, catch_unwind};
use std::sync::atomic::{AtomicBool, Ordering};

// Once armed, the first allocation of 8 bytes or more fails and disarms, so the
// reallocation inside `clone_into`'s grow path fails while the runtime's own
// smaller allocations keep succeeding.
struct OneShotFailingAlloc;

static ARMED: AtomicBool = AtomicBool::new(false);

unsafe impl GlobalAlloc for OneShotFailingAlloc {
unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
if layout.size() >= 8 && ARMED.swap(false, Ordering::SeqCst) {
return core::ptr::null_mut();
}
unsafe { System.alloc(layout) }
}

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) {
unsafe { System.dealloc(ptr, layout) }
}

unsafe fn realloc(&self, ptr: *mut u8, layout: Layout, new_size: usize) -> *mut u8 {
if new_size >= 8 && ARMED.swap(false, Ordering::SeqCst) {
return core::ptr::null_mut();
}
unsafe { System.realloc(ptr, layout, new_size) }
}
}

#[global_allocator]
static ALLOC: OneShotFailingAlloc = OneShotFailingAlloc;

// `<CStr as ToOwned>::clone_into` must leave the target `CString` valid even when
// the reallocation for its grow path unwinds. See rust-lang/rust#155707.
fn main() {
set_alloc_error_hook(|_| panic!("alloc error"));
panic::set_hook(Box::new(|_| {})); // keep the caught panic quiet

let src = CString::new("a fairly long value").unwrap();
let mut target = CString::new("x").unwrap();

ARMED.store(true, Ordering::SeqCst);
let res = catch_unwind(AssertUnwindSafe(|| src.as_c_str().clone_into(&mut target)));
ARMED.store(false, Ordering::SeqCst);

assert!(res.is_err(), "clone_into should have unwound on the alloc failure");
// `target` must still end in its nul terminator; before the fix it was left empty.
assert_eq!(target.as_bytes_with_nul().last(), Some(&0));
}
Loading