traceforge 0.2.1

TraceForge is a model checker for concurrent and distributed programs written in Rust
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::sync::Arc;

use traceforge::sync::mutex::Mutex;
use traceforge::thread;
// this file shows some example usage of the Must's `sync::mutex` library

#[test]
fn single_producer() {
    let f = || {
        let m = Arc::new(Mutex::new(5));
        let mclone = m.clone();
        traceforge::future::block_on(async move {
            let mut v = mclone.lock().await;
            traceforge::assert(*v == 5);
            *v = *v + 1;
        });
        traceforge::future::block_on(async {
            let v = m.lock().await;
            traceforge::assert(*v == 6);
        });
    };

    let stats = traceforge::verify(
        traceforge::Config::builder()
            .with_keep_going_after_error(false)
            .build(),
        f,
    );
    println!("Stats = {}, {}", stats.execs, stats.block);
}

#[test]
fn multiple_producer() {
    let f = || {
        let m = Arc::new(Mutex::new(5));
        let m1 = m.clone();
        let m2 = m.clone();
        let t1 = thread::spawn(move || {
            traceforge::future::block_on(async {
                let mut v = m1.lock().await;
                *v = *v + 1;
            });
        });
        let t2 = thread::spawn(move || {
            traceforge::future::block_on(async {
                let mut v = m2.lock().await;
                *v = *v + 1;
            });
        });
        let _ = t1.join();
        let _ = t2.join();
        assert!(*m.blocking_lock() == 7)
    };

    let stats = traceforge::verify(
        traceforge::Config::builder()
            .with_verbose(2)
            .with_keep_going_after_error(false)
            .build(),
        f,
    );
    assert_eq!(stats.execs, 2); // two executions: T1 releases lock before T2 and vice versa
                                //
                                // for each of these, the lock in the main thread does not add any
                                // more executions
    assert_eq!(stats.block, 0);
    println!("Stats = {}, {}", stats.execs, stats.block);
}

#[test]
fn race_condition() {
    let stats = traceforge::verify(traceforge::Config::default(), || {
        let mutex = Arc::new(Mutex::new(1));

        let mutex2 = mutex.clone();
        let f1 = traceforge::future::spawn(async move {
            let mut val = mutex2.lock().await;
            *val += 1;
        });

        let mutex2 = mutex.clone();
        let f2 = traceforge::future::spawn(async move {
            let mut val = mutex2.lock().await;
            *val *= 10;
        });

        traceforge::future::block_on(f1).unwrap();
        traceforge::future::block_on(f2).unwrap();

        let ending_val = traceforge::future::block_on(async move {
            let val = mutex.lock().await;
            *val
        });

        traceforge::cover!("20", ending_val == 20); // (1 + 1) * 10
        traceforge::cover!("11", ending_val == 11); // 1 + (1 * 10)
    });
    assert_eq!((2, 0), (stats.execs, stats.block));
    assert!(stats.coverage.is_covered("20".into()));
    assert!(stats.coverage.is_covered("11".into()));
}

#[test]
fn mutex_doc_test() {
    let stats = traceforge::verify(traceforge::Config::default(), || {
        traceforge::future::block_on(async {
            let count = Arc::new(Mutex::new(0));

            for i in 0..3 {
                let my_count = Arc::clone(&count);
                traceforge::thread::spawn(move || {
                    for j in 0..2 {
                        let mut lock = my_count.blocking_lock();
                        *lock += 1;
                        println!("{} {} {}", i, j, lock);
                    }
                });
            }

            let endval = *count.lock().await;
            traceforge::cover!("0", endval == 0);
            traceforge::cover!("1", endval == 1);
            traceforge::cover!("2", endval == 2);
            traceforge::cover!("3", endval == 3);
            traceforge::cover!("4", endval == 4);
            traceforge::cover!("5", endval == 5);
            traceforge::cover!("6", endval == 6);
            traceforge::cover!("7", endval == 7);

            println!("Count hit {endval}.");
        });
    });
    print!("Stats = {}, {}", stats.execs, stats.block);
    assert!(stats.coverage.is_covered("0".into()));
    assert!(stats.coverage.is_covered("1".into()));
    assert!(stats.coverage.is_covered("2".into()));
    assert!(stats.coverage.is_covered("3".into()));
    assert!(stats.coverage.is_covered("4".into()));
    assert!(stats.coverage.is_covered("5".into()));
    assert!(stats.coverage.is_covered("6".into()));

    assert!(!stats.coverage.is_covered("7".into()));
}