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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use std::thread::sleep;
use std::time::{Duration, Instant};

use traceforge::thread;
use traceforge::thread::ThreadId;
use traceforge::Config;

// Messages to coordinator
#[derive(Clone, PartialEq, Debug)]
pub enum CoordinatorMsg {
    Init(Vec<ThreadId>),
    Yes,
    No,
}

// Messages to participants
#[derive(Clone, PartialEq, Debug)]
pub enum ParticipantMsg {
    Prepare(ThreadId),
    Commit,
    Abort,
}

fn coordinator(ps: Vec<ThreadId>) {
    // send "prepare" messages
    ps.iter()
        .for_each(|id| traceforge::send_msg(*id, ParticipantMsg::Prepare(thread::current().id())));

    // collect responses
    let mut num_yes = 0;
    for _ in 0..ps.len() {
        let r_i: CoordinatorMsg = traceforge::recv_msg_block();
        match r_i {
            CoordinatorMsg::Yes => num_yes += 1,
            CoordinatorMsg::No => (),
            _ => panic!(),
        };
    }
    if num_yes == ps.len() {
        ps.iter()
            .for_each(|id| traceforge::send_msg(*id, ParticipantMsg::Commit));
    } else {
        ps.iter()
            .for_each(|id| traceforge::send_msg(*id, ParticipantMsg::Abort));
    }
}

fn participant() {
    let cid = if let ParticipantMsg::Prepare(id) = traceforge::recv_msg_block() {
        id
    } else {
        // Unexpected message in the protocol
        panic!();
    };

    // P1
    let response = traceforge::nondet();
    if response {
        traceforge::send_msg(cid, CoordinatorMsg::Yes);
    } else {
        traceforge::send_msg(cid, CoordinatorMsg::No);
    }

    // P2
    let action = traceforge::recv_msg_block();
    match action {
        ParticipantMsg::Commit => assert!(response),
        ParticipantMsg::Abort => (),
        _ => panic!(),
    }
}

fn scenario(num_ps: u32) {
    let mut ps = Vec::new();
    for _i in 0..num_ps {
        ps.push(thread::spawn(participant));
    }
    let pids = ps.iter().map(|tid| tid.thread().id()).collect();
    let _ = thread::spawn(move || coordinator(pids));
    //sleep(Duration::from_millis(400));
}

#[test]
fn two_pc_serial() {
    let now = Instant::now();
    let num_ps: u32 = 5;

    let stats = traceforge::verify(
        Config::builder()
            //.with_dot_out("twopc.dot")
            //.with_error_trace("twopc.bug")
            //.with_verbose(1)
            .build(),
        move || scenario(num_ps),
    );
    assert_eq!(
        stats.execs as u32,
        2_u32.pow(num_ps) * (1..=num_ps).product::<u32>()
    ); // 2^N * N!
    assert_eq!(stats.block, 0);
    let elapsed = now.elapsed();
    println!("Elapsed: {:.2?}", elapsed);
}

#[ignore]
#[test]
#[should_panic(expected = "assertion failed")]
fn replay_from_file() {
    let num_ps = 3;
    traceforge::replay(
        move || {
            let mut ps = Vec::new();
            for _i in 0..num_ps {
                ps.push(thread::spawn(participant));
            }
            let pids = ps.iter().map(|tid| tid.thread().id()).collect();
            let _ = thread::spawn(move || coordinator(pids));
            sleep(Duration::from_millis(100));
        },
        "./twopc.bug",
    );
}

//#[ignore = "Runs too long"]
#[test]
fn two_pc_parallel() {
    let now = Instant::now();
    let num_ps: u32 = 6;
    let stats = traceforge::verify(Config::builder().with_parallel(true).build(), move || {
        let mut ps = Vec::new();
        for _i in 0..num_ps {
            ps.push(thread::spawn(participant));
        }
        let pids = ps.iter().map(|tid| tid.thread().id()).collect();
        let _ = thread::spawn(move || coordinator(pids));
    });

    assert_eq!(
        stats.execs as u32,
        2_u32.pow(num_ps) * (1..=num_ps).product::<u32>()
    ); // 2^N * N!

    assert_eq!(stats.block, 0);
    let elapsed = now.elapsed();
    println!("Elapsed: {:.2?}", elapsed);
}

#[test]
fn two_pc_test() {
    let now = Instant::now();
    let num_ps: u32 = 6;

    let stats_vec = traceforge::parallel_test(
        Config::builder()
            .with_dot_out("twopc.dot")
            .with_error_trace("twopc.bug")
            .with_max_iterations(2)
            //.with_verbose(1)
            .build(),
        move || scenario(num_ps),
    );
    for stats in stats_vec {
        assert_eq!(
            stats.execs as u32,
            2, // 2_u32.pow(num_ps) * (1..=num_ps).product::<u32>()
        ); // 2^N * N!
        assert_eq!(stats.block, 0);
    }
    let elapsed = now.elapsed();
    println!("Elapsed: {:.2?}", elapsed);
}