xlsynth 0.60.0

Accelerated Hardware Synthesis (XLS/XLSynth) via 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

// SPDX-License-Identifier: Apache-2.0

use xlsynth::{IrBits, XlsynthError};

#[test]
fn arith_and_logic_ops() -> Result<(), XlsynthError> {
    let a = IrBits::make_ubits(8, 0b0001_1010)?; // 26
    let b = IrBits::make_ubits(8, 0b0000_0011)?; // 3

    assert!(a.equals(&a));
    assert!(!a.equals(&b));
    assert_eq!(a.clone(), a.clone());
    assert_ne!(a.clone(), b.clone());
    assert!(a.get_bit(1)?);

    let sum = a.add(&b);
    assert_eq!(sum.to_u64()?, 29);

    let diff = a.sub(&b);
    assert_eq!(diff.to_u64()?, 23);

    let and = a.and(&b);
    assert_eq!(and.to_u64()?, 0b0000_0010);

    let or = a.or(&b);
    assert_eq!(or.to_u64()?, 0b0001_1011);

    let xor = a.xor(&b);
    assert_eq!(xor.to_u64()?, 0b0001_1001);

    let not_a = a.not();
    assert_eq!(not_a.to_u64()?, 0b1110_0101);

    let neg = a.negate();
    let abs = neg.abs();
    assert_eq!(abs, a);

    let umul = a.umul(&b);
    assert_eq!(umul.to_u64()?, 78);

    let smul = a.smul(&b);
    assert_eq!(smul.to_u64()?, 78);

    Ok(())
}

// Verifies: conversions expose little-endian bytes alongside shifts and slices.
// Catches: byte-order regressions in `IrBits::to_le_bytes`.
#[test]
fn conversions_shifts_and_slices() -> Result<(), XlsynthError> {
    let bits = IrBits::make_sbits(8, -2)?;
    assert_eq!(bits.to_i64()?, -2);
    assert_eq!(bits.to_u64()?, 0xFE);
    assert!(!bits.get_bit(0)?);
    assert!(bits.get_bit(1)?);

    let bytes = bits.to_le_bytes()?;
    assert_eq!(bytes, vec![0xFE]);

    let wide = IrBits::make_ubits(16, 0xABCD)?;
    assert_eq!(wide.to_le_bytes()?, vec![0xCD, 0xAB]);

    let from_bytes = IrBits::from_le_bytes(12, &[0xCD, 0x0A])?;
    assert_eq!(from_bytes.get_bit_count(), 12);
    assert_eq!(from_bytes.to_le_bytes()?, vec![0xCD, 0x0A]);
    assert!(IrBits::from_le_bytes(12, &[0xCD, 0xFA]).is_err());

    let shll = bits.shll(2);
    assert_eq!(shll.to_u64()?, (0xFEu64 << 2) & 0xFF);

    let shrl = bits.shrl(2);
    assert_eq!(shrl.to_u64()?, 0xFE >> 2);

    let shra = bits.shra(2);
    assert_eq!(shra.to_i64()?, -1);

    let slice = wide.width_slice(8, 8);
    assert_eq!(slice.to_u64()?, 0xAB);

    Ok(())
}

#[test]
fn comparison_methods_require_matching_widths() -> Result<(), XlsynthError> {
    let small = IrBits::make_ubits(4, 0b0011)?;
    let medium = IrBits::make_ubits(4, 0b0100)?;
    let wide = IrBits::make_ubits(8, 0b0000_0100)?;

    assert!(small.ult(&medium));
    assert!(medium.ugt(&small));
    assert!(small.ule(&small));
    assert!(medium.uge(&small));

    let negative = IrBits::make_sbits(4, -1)?;
    let positive = IrBits::make_sbits(4, 1)?;
    assert!(negative.slt(&positive));
    assert!(positive.sgt(&negative));
    assert!(negative.sle(&negative));
    assert!(positive.sge(&negative));

    let panic_result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| small.ult(&wide)));
    assert!(panic_result.is_err());

    Ok(())
}

#[test]
fn division_mod_and_construction_helpers() -> Result<(), XlsynthError> {
    assert_eq!(IrBits::zero(8).to_u64()?, 0);
    assert_eq!(IrBits::all_ones(8).to_u64()?, 0xFF);
    assert_eq!(IrBits::signed_max_value(8).to_u64()?, 0x7F);
    assert_eq!(IrBits::signed_min_value(8).to_u64()?, 0x80);
    assert!(!IrBits::signed_max_value(8).is_negative());
    assert!(IrBits::signed_min_value(8).is_negative());

    let lhs_u = IrBits::make_ubits(8, 0xBC)?;
    let rhs_u = IrBits::make_ubits(8, 0x07)?;
    assert_eq!(lhs_u.udiv(&rhs_u).to_u64()?, 0x1A);
    assert_eq!(lhs_u.umod(&rhs_u).to_u64()?, 0x06);
    assert_eq!(lhs_u.udiv(&IrBits::zero(8)).to_u64()?, 0xFF);
    assert_eq!(lhs_u.umod(&IrBits::zero(8)).to_u64()?, 0x00);

    let lhs_s = IrBits::make_sbits(8, -68)?;
    let rhs_s = IrBits::make_sbits(8, -7)?;
    assert_eq!(lhs_s.sdiv(&rhs_s).to_i64()?, 9);
    assert_eq!(lhs_s.smod(&rhs_s).to_i64()?, -5);
    assert_eq!(lhs_s.sdiv(&IrBits::zero(8)).to_u64()?, 0x80);
    assert_eq!(lhs_s.smod(&IrBits::zero(8)).to_u64()?, 0x00);

    Ok(())
}