Reinventing From Scratch — Box<T>

Chapter 11 — Tests, Miri, and a Shipping Checklist

11.1 Unit tests

#[test]
fn box_roundtrip() {
    let b = MyBox::new(String::from("namaste"));
    assert_eq!(&*b, "namaste");
}

#[test]
fn box_into_from_raw() {
    let b = MyBox::new(42u64);
    let p = MyBox::into_raw(b);
    let b2 = unsafe { MyBox::from_raw(p) };
    assert_eq!(*b2, 42);
}

#[test]
fn box_leak() {
    let b = MyBox::new(7usize);
    let r: &'static mut usize = MyBox::leak(b);
    *r += 1;
    assert_eq!(*r, 8);
    // intentional leak
}

11.2 Miri

Run this under Miri to catch UB like use‑after‑free and invalid reads:

cargo +nightly miri test

11.3 Fuzzing (optional)

Fuzz into_raw/from_raw roundtrips and destructor paths; compare against std Box behavior when possible.

11.4 Shipping checklist

drop_in_place runs before dealloc.
from_raw only wraps pointers from into_raw (same type/allocator).
Never create references to uninitialized memory.
Handle into_raw “disarmed” state in Drop (null check).
If switching to NonNull, never store null — construct after alloc.

Exercise

Write a property test asserting that MyBox::into_raw followed by from_raw roundtrips values for several primitive types and String.

Deep Dive: Ownership Proofs, Drop Order, and DST Considerations

A. Formal Invariants for `MyBox<T>` (Sized)

B1 (Pointer Validity): ptr is either null only after into_raw or a valid, properly aligned pointer to initialized T.
B2 (Single Drop): The destructor of T is invoked exactly once if and only if ptr is non-null at Drop time.
B3 (Dealloc after Drop): dealloc(layout_of::<T>()) is called exactly once, and only after drop_in_place.
B4 (From/Into Raw Consistency): from_raw only accepts pointers produced by into_raw of the same type/allocator; mixing allocators is UB.
B5 (No References to Uninit): No &/&mut references are created before ptr::write initializes the allocation.

B.1 Single Drop — Drop checks for null and calls drop_in_place once; into_raw nulls out ptr and forgets self, preventing Drop from running on a live value.
B.2 No Use-After-Free — Deallocation happens only after the destructor; references returned by Deref are derived from a live ptr and never stored beyond the box’s lifetime.
B.3 Panic Safety — If constructor panics before publishing, no ownership is established; if Drop panics (should not), process aborts, avoiding double-unwind corruption.

C. DST Box Notes

Slices (Box<[T]>): store length; the fat pointer (data, len) enables correct deallocation.
Box<str>: same as [u8] with UTF‑8 invariant; length in metadata.
Box<dyn Trait>: fat pointer (data, vtable); the vtable encodes drop and size/alignment; std uses compiler magic for correct layout.

D. Interop Patterns

FFI Ownership Transfer: into_raw -> C takes ownership; C must call back into Rust with from_raw or a custom free.
Leaking Globals: leak returns 'static reference, acceptable for process lifetime singletons; document intent.

E. Debugging

Double Drop: look for *p assignment instead of ptr::write on uninitialized memory.
Mismatched Layout: using dealloc with wrong Layout causes heap corruption; keep Layout::new::<T>() paired.

F. Exercises

Implement try_new returning Result<MyBox<T>, AllocError>.
Add into_inner(self) -> T by ptr::read and skipping dealloc? Explain why you must still dealloc after moving T.
Implement MyVec::into_boxed_slice that hands RawVec buffer to a Box<[T]> safely.

FAQ (Extended)

Q: Does Box<T> guarantee a stable address? A: Yes, the pointee’s address is stable for the life of the box; moving the box moves only the handle.
Q: Why ptr::write not *p = value? A: The latter reads/drops the previous contents (uninitialized), which is UB.
Q: Can Box<T> be null? A: By design, standard Box<T> is non-null; our MyBox may set ptr = null only as a consumed sentinel post-into_raw.
Q: Is Pin<Box<T>> needed for stable address? A: Not for stability; Pin is for forbidding moves via the API.

Testing, Miri, and Checklist