checkers 0.7.1

A sanity checker for global allocations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use std::alloc::{GlobalAlloc, Layout, System};
use std::ptr;

/// Note: allocator which intentionally doesn't allocate a zeroed region.
struct TestAllocator;

unsafe impl GlobalAlloc for TestAllocator {
    unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
        if checkers::is_muted() {
            return System.alloc(layout);
        }

        ptr::null_mut()
    }

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

    unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8 {
        if checkers::is_muted() {
            return System.alloc_zeroed(layout);
        }

        ptr::null_mut()
    }

    unsafe fn realloc(&self, ptr: *mut u8, layout: Layout, new_size: usize) -> *mut u8 {
        if checkers::is_muted() {
            return System.realloc(ptr, layout, new_size);
        }

        ptr::null_mut()
    }
}

#[global_allocator]
static ALLOCATOR: checkers::Allocator<TestAllocator> = checkers::Allocator::new(TestAllocator);

#[test]
fn test_failed_alloc_zeroed() {
    let layout = Layout::from_size_align(10, 1).unwrap();

    let snapshot = checkers::with(|| unsafe {
        assert_eq!(ptr::null_mut(), ALLOCATOR.alloc_zeroed(layout));
    });

    assert_eq!(1, snapshot.events.len());
    assert!(snapshot.events[0].is_failed());
}

#[test]
fn test_failed_alloc() {
    let layout = Layout::from_size_align(10, 1).unwrap();

    let snapshot = checkers::with(|| unsafe {
        assert_eq!(ptr::null_mut(), ALLOCATOR.alloc(layout));
    });

    assert_eq!(1, snapshot.events.len());
    assert!(snapshot.events[0].is_failed());
}

#[test]
fn test_failed_realloc() {
    let layout = Layout::from_size_align(10, 1).unwrap();

    let p = unsafe { ALLOCATOR.alloc(layout) };

    for n in 0..10 {
        unsafe {
            ptr::write(p.add(n), n as u8);
        }
    }

    assert!(!p.is_null());

    let snapshot = checkers::with(|| unsafe {
        // NB: These events will fail because checkers is enabled.
        assert_eq!(ptr::null_mut(), ALLOCATOR.realloc(p, layout, 20));
        ALLOCATOR.dealloc(p, layout);
    });

    assert_eq!(2, snapshot.events.len());
    assert!(snapshot.events[0].is_failed());
    assert!(
        snapshot.events[1].is_free_with(|r| r.size == layout.size() && r.align == layout.align())
    );
}