mck 0.7.1

Utility crate for the formal verification tool machine-check
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

use std::{
    fmt::{Debug, Display},
    ops::{Add, BitAnd, BitOr, BitXor, Div, Mul, Not, Rem, Shl, Shr, Sub},
};

use serde::{Deserialize, Serialize};

use crate::{
    bitvector::BitvectorBound,
    concr::{OutsideBound, PanicResult},
    forward::{BExt, Bitwise, HwArith, HwShift},
};

use super::ConcreteBitvector;

#[derive(Clone, Copy, Hash, PartialEq, Eq, Serialize, Deserialize)]
pub struct UnsignedBitvector<B: BitvectorBound>(ConcreteBitvector<B>);

impl<B: BitvectorBound> UnsignedBitvector<B> {
    pub fn new(value: u64, bound: B) -> Self {
        UnsignedBitvector(ConcreteBitvector::new(value, bound))
    }

    pub fn try_new(value: u64, bound: B) -> Result<Self, OutsideBound<u64>> {
        ConcreteBitvector::try_new(value, bound).map(UnsignedBitvector)
    }

    pub fn bound(&self) -> B {
        self.0.bound
    }

    pub fn zero(bound: B) -> Self {
        UnsignedBitvector(ConcreteBitvector::new(0, bound))
    }

    pub fn one(bound: B) -> Self {
        UnsignedBitvector(ConcreteBitvector::new(1, bound))
    }

    pub(super) const fn from_bitvector(bitvector: ConcreteBitvector<B>) -> Self {
        UnsignedBitvector(bitvector)
    }

    pub fn cast_bitvector(self) -> ConcreteBitvector<B> {
        self.0
    }

    pub fn to_u64(self) -> u64 {
        self.0.to_u64()
    }

    pub fn is_zero(&self) -> bool {
        self.0.is_zero()
    }

    pub fn is_nonzero(&self) -> bool {
        self.0.is_nonzero()
    }

    pub fn ext<X: BitvectorBound>(self, new_bound: X) -> UnsignedBitvector<X> {
        UnsignedBitvector(self.0.uext(new_bound))
    }
}

impl<B: BitvectorBound> Add<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = Self;

    fn add(self, rhs: UnsignedBitvector<B>) -> Self::Output {
        Self(self.0.add(rhs.0))
    }
}

impl<B: BitvectorBound> Sub<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = Self;

    fn sub(self, rhs: UnsignedBitvector<B>) -> Self::Output {
        Self(self.0.sub(rhs.0))
    }
}

impl<B: BitvectorBound> Mul<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = Self;

    fn mul(self, rhs: UnsignedBitvector<B>) -> Self::Output {
        Self(self.0.mul(rhs.0))
    }
}

impl<B: BitvectorBound> Div<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = PanicResult<Self>;

    fn div(self, rhs: UnsignedBitvector<B>) -> PanicResult<Self> {
        // unsigned division
        let panic_result = self.0.udiv(rhs.0);
        PanicResult {
            panic: panic_result.panic,
            result: Self(panic_result.result),
        }
    }
}

impl<B: BitvectorBound> Rem<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = PanicResult<Self>;

    fn rem(self, rhs: UnsignedBitvector<B>) -> PanicResult<Self> {
        // unsigned remainder
        let panic_result = self.0.urem(rhs.0);
        PanicResult {
            panic: panic_result.panic,
            result: Self(panic_result.result),
        }
    }
}

impl<B: BitvectorBound> Not for UnsignedBitvector<B> {
    type Output = Self;

    fn not(self) -> Self::Output {
        Self(self.0.bit_not())
    }
}

impl<B: BitvectorBound> BitAnd for UnsignedBitvector<B> {
    type Output = Self;

    fn bitand(self, rhs: Self) -> Self::Output {
        Self(self.0.bit_and(rhs.0))
    }
}

impl<B: BitvectorBound> BitOr for UnsignedBitvector<B> {
    type Output = Self;

    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0.bit_or(rhs.0))
    }
}

impl<B: BitvectorBound> BitXor for UnsignedBitvector<B> {
    type Output = Self;

    fn bitxor(self, rhs: Self) -> Self::Output {
        Self(self.0.bit_xor(rhs.0))
    }
}

impl<B: BitvectorBound> Shl<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = Self;

    fn shl(self, rhs: UnsignedBitvector<B>) -> Self::Output {
        // both signed and unsigned use logic shift left
        Self(self.0.logic_shl(rhs.0))
    }
}

impl<B: BitvectorBound> Shr<UnsignedBitvector<B>> for UnsignedBitvector<B> {
    type Output = Self;

    fn shr(self, rhs: UnsignedBitvector<B>) -> Self::Output {
        // signed uses arithmetic shift right
        Self(self.0.logic_shr(rhs.0))
    }
}

impl<B: BitvectorBound> PartialOrd for UnsignedBitvector<B> {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl<B: BitvectorBound> Ord for UnsignedBitvector<B> {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        // unsigned comparison
        self.0.unsigned_cmp(&other.0)
    }
}

impl<B: BitvectorBound> Debug for UnsignedBitvector<B> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Debug::fmt(&self.to_u64(), f)
    }
}

impl<B: BitvectorBound> Display for UnsignedBitvector<B> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&self.to_u64(), f)
    }
}