splitrs 0.3.5

AST-based Rust refactoring tool with trait separation, config files, and intelligent module generation
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

//! Integration tests for the QF_BV equivalence oracle (`smt` feature).
//!
//! Each test builds a pair of `syn::ItemFn` values and asserts the proven
//! [`Verdict`]. Soundness-critical cases (signed arithmetic shift, refutation
//! with a concrete counterexample) are covered explicitly.

#![cfg(feature = "smt")]

use splitrs::smt::{prove_equivalent, Verdict};
use syn::parse_quote;

/// Assert that two functions are proven equivalent.
fn assert_verified(a: syn::ItemFn, b: syn::ItemFn) {
    match prove_equivalent(&a, &b) {
        Verdict::Verified => {}
        other => panic!("expected Verified, got {other:?}"),
    }
}

/// Assert that two functions are reported Unsupported.
fn assert_unsupported(a: syn::ItemFn, b: syn::ItemFn) {
    match prove_equivalent(&a, &b) {
        Verdict::Unsupported { .. } => {}
        other => panic!("expected Unsupported, got {other:?}"),
    }
}

#[test]
fn add_is_commutative() {
    let a: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { a + b } };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { b + a } };
    assert_verified(a, b);
}

#[test]
fn double_equals_self_add() {
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { 2 * x } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x + x } };
    assert_verified(a, b);
}

#[test]
fn add_is_associative() {
    let a: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32, c: u32) -> u32 { (a + b) + c } };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32, c: u32) -> u32 { a + (b + c) } };
    assert_verified(a, b);
}

#[test]
fn mul_by_two_equals_shift_left_unsigned() {
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x * 2 } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x << 1 } };
    assert_verified(a, b);
}

#[test]
fn mul_by_three_is_not_identity() {
    // Regression guard for a counterexample-extraction soundness bug: binding a
    // fresh `out == body` variable before the disequality check made a genuine
    // `Sat` collapse to `Unsat` whenever the body contained a bit-vector multiply
    // (so `x * 3` was wrongly "proven" equal to `x`). The oracle now decides the
    // verdict from the bare disequality, so a non-power-of-two multiply must be
    // correctly REFUTED against the identity.
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x * 3 } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x } };
    match prove_equivalent(&a, &b) {
        Verdict::Refuted(cx) => {
            assert!(
                !cx.inputs.is_empty(),
                "a refutation must carry a concrete witness for x"
            );
        }
        other => panic!("`x * 3` must be Refuted against `x`, got {other:?}"),
    }
}

#[test]
fn mul_by_three_equals_repeated_addition() {
    // Companion to the regression guard: a genuine multiply identity must still
    // be Verified (the fix must not over-reject). `x * 3 == x + x + x`.
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x * 3 } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x + x + x } };
    assert_verified(a, b);
}

#[test]
fn mul_with_let_binding_is_not_identity() {
    // The same soundness guard through a `let`-bound multiply (the shape the
    // extraction transform produces): `let t = x * 3; t` must be Refuted vs `x`.
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { let t = x * 3; t } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x } };
    match prove_equivalent(&a, &b) {
        Verdict::Refuted(_) => {}
        other => panic!("`let t = x * 3; t` must be Refuted against `x`, got {other:?}"),
    }
}

#[test]
fn if_swap_with_negated_condition() {
    let a: syn::ItemFn = parse_quote! {
        fn f(a: i32, b: i32, c: bool) -> i32 { if c { a } else { b } }
    };
    let b: syn::ItemFn = parse_quote! {
        fn f(a: i32, b: i32, c: bool) -> i32 { if !c { b } else { a } }
    };
    assert_verified(a, b);
}

#[test]
fn de_morgan_law() {
    let a: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { !(a & b) } };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { (!a) | (!b) } };
    assert_verified(a, b);
}

#[test]
fn cast_narrow_widen_equals_mask() {
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { (x as u8) as u32 } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x & 0xFF } };
    assert_verified(a, b);
}

#[test]
fn refute_add_vs_sub_with_counterexample() {
    let a: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { a + b } };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { a - b } };
    match prove_equivalent(&a, &b) {
        Verdict::Refuted(cx) => {
            // The counterexample must populate both inputs.
            assert_eq!(cx.inputs.len(), 2, "expected two input bindings");
            let b_val = cx
                .inputs
                .iter()
                .find(|(name, _)| name == "b")
                .map(|(_, v)| v.clone())
                .expect("counterexample must bind `b`");
            // a + b and a - b differ exactly when b != 0.
            assert_ne!(
                b_val, "0",
                "counterexample must have b != 0, got b = {b_val}"
            );
        }
        other => panic!("expected Refuted, got {other:?}"),
    }
}

#[test]
fn unsupported_function_call() {
    let a: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { foo(x) } };
    let b: syn::ItemFn = parse_quote! { fn f(x: u32) -> u32 { x } };
    assert_unsupported(a, b);
}

#[test]
fn unsupported_float_param() {
    let a: syn::ItemFn = parse_quote! { fn f(x: f32) -> f32 { x } };
    let b: syn::ItemFn = parse_quote! { fn f(x: f32) -> f32 { x } };
    assert_unsupported(a, b);
}

#[test]
fn signed_shift_uses_arithmetic_shift() {
    // For a signed value, `x >> 1` is an *arithmetic* shift (sign-preserving).
    // The identity `(x >> 1) + (x >> 1)` differs from `x` for odd/negative x,
    // but we can pin the ashr vs lshr distinction with a sign-sensitive
    // identity: for i32, `(-2) >> 1 == -1`. We prove that an explicit
    // arithmetic-shift model agrees with Rust's `>>` on signed, by checking
    // that `x >> 1` equals itself encoded as signed (trivially Verified) AND
    // that the *unsigned* reinterpretation differs — captured below.
    //
    // Concretely: prove `x >> 1` (i32, arithmetic) is NOT equivalent to
    // `(x as u32) >> 1) as i32` (logical) — they disagree on negative x. A
    // Refuted verdict guards that signed `>>` lowered to ashr, not lshr.
    let arithmetic: syn::ItemFn = parse_quote! { fn f(x: i32) -> i32 { x >> 1 } };
    let logical: syn::ItemFn = parse_quote! { fn f(x: i32) -> i32 { ((x as u32) >> 1) as i32 } };
    match prove_equivalent(&arithmetic, &logical) {
        Verdict::Refuted(cx) => {
            // They must differ on some negative input (high bit set).
            let x_val = cx
                .inputs
                .iter()
                .find(|(name, _)| name == "x")
                .map(|(_, v)| v.clone())
                .expect("counterexample must bind `x`");
            assert!(
                x_val.starts_with('-'),
                "ashr vs lshr should diverge on a negative x, got x = {x_val}"
            );
        }
        other => {
            panic!("expected Refuted (proving signed >> is arithmetic, not logical), got {other:?}")
        }
    }
}

#[test]
fn signed_arithmetic_shift_self_identity() {
    // Sanity companion: signed `>>` against itself is Verified — confirms the
    // ashr path is internally consistent.
    let a: syn::ItemFn = parse_quote! { fn f(x: i32) -> i32 { x >> 2 } };
    let b: syn::ItemFn = parse_quote! { fn f(x: i32) -> i32 { (x >> 1) >> 1 } };
    assert_verified(a, b);
}

#[test]
fn let_binding_and_shadowing() {
    // `let` bindings (with SSA renaming for shadowing) must encode correctly.
    let a: syn::ItemFn = parse_quote! {
        fn f(a: u32, b: u32) -> u32 {
            let s = a + b;
            let s = s + s;
            s
        }
    };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { (a + b) * 2 } };
    assert_verified(a, b);
}

#[test]
fn trailing_return_is_allowed() {
    let a: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { return a + b; } };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { b + a } };
    assert_verified(a, b);
}

#[test]
fn division_is_unsupported() {
    let a: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { a / b } };
    let b: syn::ItemFn = parse_quote! { fn f(a: u32, b: u32) -> u32 { a / b } };
    assert_unsupported(a, b);
}