another-boids-in-rust/vendor/nix/test/sys/test_mman.rs

#![allow(clippy::redundant_slicing)]

use nix::sys::mman::{mmap_anonymous, MapFlags, ProtFlags};
use std::num::NonZeroUsize;

#[test]
fn test_mmap_anonymous() {
    unsafe {
        let mut ptr = mmap_anonymous(
            None,
            NonZeroUsize::new(1).unwrap(),
            ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
            MapFlags::MAP_PRIVATE,
        )
        .unwrap()
        .cast::<u8>();
        assert_eq!(*ptr.as_ref(), 0x00u8);
        *ptr.as_mut() = 0xffu8;
        assert_eq!(*ptr.as_ref(), 0xffu8);
    }
}

#[test]
#[cfg(any(target_os = "linux", target_os = "netbsd"))]
fn test_mremap_grow() {
    use nix::libc::size_t;
    use nix::sys::mman::{mremap, MRemapFlags};
    use std::ptr::NonNull;

    const ONE_K: size_t = 1024;
    let one_k_non_zero = NonZeroUsize::new(ONE_K).unwrap();

    let slice: &mut [u8] = unsafe {
        let mem = mmap_anonymous(
            None,
            one_k_non_zero,
            ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
            MapFlags::MAP_PRIVATE,
        )
        .unwrap();
        std::slice::from_raw_parts_mut(mem.as_ptr().cast(), ONE_K)
    };
    assert_eq!(slice[ONE_K - 1], 0x00);
    slice[ONE_K - 1] = 0xFF;
    assert_eq!(slice[ONE_K - 1], 0xFF);

    let slice: &mut [u8] = unsafe {
        #[cfg(target_os = "linux")]
        let mem = mremap(
            NonNull::from(&mut slice[..]).cast(),
            ONE_K,
            10 * ONE_K,
            MRemapFlags::MREMAP_MAYMOVE,
            None,
        )
        .unwrap();
        #[cfg(target_os = "netbsd")]
        let mem = mremap(
            NonNull::from(&mut slice[..]).cast(),
            ONE_K,
            10 * ONE_K,
            MRemapFlags::MAP_REMAPDUP,
            None,
        )
        .unwrap();
        std::slice::from_raw_parts_mut(mem.cast().as_ptr(), 10 * ONE_K)
    };

    // The first KB should still have the old data in it.
    assert_eq!(slice[ONE_K - 1], 0xFF);

    // The additional range should be zero-init'd and accessible.
    assert_eq!(slice[10 * ONE_K - 1], 0x00);
    slice[10 * ONE_K - 1] = 0xFF;
    assert_eq!(slice[10 * ONE_K - 1], 0xFF);
}

#[test]
#[cfg(any(target_os = "linux", target_os = "netbsd"))]
// Segfaults for unknown reasons under QEMU for 32-bit targets
#[cfg_attr(all(target_pointer_width = "32", qemu), ignore)]
fn test_mremap_shrink() {
    use nix::libc::size_t;
    use nix::sys::mman::{mremap, MRemapFlags};
    use std::num::NonZeroUsize;
    use std::ptr::NonNull;

    const ONE_K: size_t = 1024;
    let ten_one_k = NonZeroUsize::new(10 * ONE_K).unwrap();
    let slice: &mut [u8] = unsafe {
        let mem = mmap_anonymous(
            None,
            ten_one_k,
            ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
            MapFlags::MAP_PRIVATE,
        )
        .unwrap();
        std::slice::from_raw_parts_mut(mem.as_ptr().cast(), ONE_K)
    };
    assert_eq!(slice[ONE_K - 1], 0x00);
    slice[ONE_K - 1] = 0xFF;
    assert_eq!(slice[ONE_K - 1], 0xFF);

    let slice: &mut [u8] = unsafe {
        let mem = mremap(
            NonNull::from(&mut slice[..]).cast(),
            ten_one_k.into(),
            ONE_K,
            MRemapFlags::empty(),
            None,
        )
        .unwrap();
        // Since we didn't supply MREMAP_MAYMOVE, the address should be the
        // same.
        assert_eq!(mem.as_ptr(), NonNull::from(&mut slice[..]).cast().as_ptr());
        std::slice::from_raw_parts_mut(mem.as_ptr().cast(), ONE_K)
    };

    // The first KB should still be accessible and have the old data in it.
    assert_eq!(slice[ONE_K - 1], 0xFF);
}

#[test]
#[cfg(target_os = "linux")]
fn test_mremap_dontunmap() {
    use nix::libc::size_t;
    use nix::sys::mman::{mremap, MRemapFlags};
    use std::num::NonZeroUsize;
    use std::ptr::NonNull;

    const ONE_K: size_t = 1024;
    let one_k_non_zero = NonZeroUsize::new(ONE_K).unwrap();

    let slice: &mut [u8] = unsafe {
        let mem = mmap_anonymous(
            None,
            one_k_non_zero,
            ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
            MapFlags::MAP_PRIVATE,
        )
        .unwrap();
        std::slice::from_raw_parts_mut(mem.as_ptr().cast(), ONE_K)
    };

    // because we do not unmap `slice`, `old_size` and `new_size`
    // need to be equal or `EINVAL` is set.
    let _new_slice: &mut [u8] = unsafe {
        let mem = mremap(
            NonNull::from(&mut slice[..]).cast(),
            ONE_K,
            ONE_K,
            MRemapFlags::MREMAP_MAYMOVE | MRemapFlags::MREMAP_DONTUNMAP,
            None,
        )
        .unwrap();
        std::slice::from_raw_parts_mut(mem.cast().as_ptr(), 10 * ONE_K)
    };
}

#[test]
#[cfg(target_os = "linux")]
fn test_madv_wipeonfork() {
    use nix::libc::size_t;
    use nix::sys::mman::{madvise, MmapAdvise};
    use nix::unistd::{fork, ForkResult};
    use std::num::NonZeroUsize;

    const ONE_K: size_t = 1024;
    let ten_one_k = NonZeroUsize::new(10 * ONE_K).unwrap();
    let slice: &mut [u8] = unsafe {
        let mem = mmap_anonymous(
            None,
            ten_one_k,
            ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
            MapFlags::MAP_PRIVATE,
        )
        .unwrap();
        madvise(mem, ONE_K, MmapAdvise::MADV_WIPEONFORK)
            .expect("madvise failed");
        std::slice::from_raw_parts_mut(mem.as_ptr().cast(), ONE_K)
    };
    slice[ONE_K - 1] = 0xFF;
    let _m = crate::FORK_MTX.lock();

    unsafe {
        let res = fork().expect("fork failed");
        match res {
            ForkResult::Child => {
                // that s the whole point of MADV_WIPEONFORK
                assert_eq!(slice[ONE_K - 1], 0x00);
                libc::_exit(0);
            }
            ForkResult::Parent { child } => {
                nix::sys::signal::kill(child, nix::sys::signal::SIGTERM)
                    .unwrap();
                let _ = nix::sys::wait::wait().unwrap();
            }
        }
    }
}