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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
use crate::{Default, *};
pub use ::std::num::*;
macro_rules! mach_int {
($t:ty, $ty_nm:expr, $zero:expr) => {
impl View for $t {
type ViewTy = Int;
#[logic]
#[trusted]
#[creusot::builtins = concat!($ty_nm, ".to_int")]
fn view(self) -> Self::ViewTy {
dead
}
}
impl DeepModel for $t {
type DeepModelTy = Int;
#[logic]
#[open]
fn deep_model(self) -> Self::DeepModelTy {
pearlite! { self@ }
}
}
impl Default for $t {
#[predicate]
#[open]
fn is_default(self) -> bool {
pearlite! { self == $zero }
}
}
};
}
mach_int!(u8, "prelude.prelude.UInt8", 0u8);
mach_int!(u16, "prelude.prelude.UInt16", 0u16);
mach_int!(u32, "prelude.prelude.UInt32", 0u32);
mach_int!(u64, "prelude.prelude.UInt64", 0u64);
mach_int!(u128, "prelude.prelude.UInt128", 0u128);
mach_int!(usize, "prelude.prelude.UIntSize", 0usize);
mach_int!(i8, "prelude.prelude.Int8", 0i8);
mach_int!(i16, "prelude.prelude.Int16", 0i16);
mach_int!(i32, "prelude.prelude.Int32", 0i32);
mach_int!(i64, "prelude.prelude.Int64", 0i64);
mach_int!(i128, "prelude.prelude.Int128", 0i128);
mach_int!(isize, "prelude.prelude.IntSize", 0isize);
/// Adds specifications for checked, wrapping, saturating, and overflowing operations on the given
/// integer type
macro_rules! spec_type {
($type:ty) => {
// Specify addition, subtraction and multiplication
spec_op_common!($type, +, checked_add, wrapping_add, saturating_add, overflowing_add);
spec_op_common!($type, -, checked_sub, wrapping_sub, saturating_sub, overflowing_sub);
spec_op_common!($type, *, checked_mul, wrapping_mul, saturating_mul, overflowing_mul);
// Specify division separately, because it has the additional precondition that the divisor
// is non-zero. Overflow on division can only occur on signed types and only when computing
// `$type::MIN / -1`.
extern_spec! {
impl $type {
#[allow(dead_code)]
#[pure]
// Returns `None` iff the divisor is zero or the division overflows
#[ensures((result == None) == (rhs@ == 0 || (self@ == $type::MIN@ && rhs@ == -1)))]
// Else, returns the result of the division
#[ensures(forall<r: $type> result == Some(r) ==> r@ == self@ / rhs@)]
fn checked_div(self, rhs: $type) -> Option<$type>;
#[allow(dead_code)]
#[pure]
// Panics if the divisor is zero
#[requires(rhs@ != 0)]
// Returns `self` if the division overflows
#[ensures((self@ == $type::MIN@ && rhs@ == -1) ==> result@ == self@)]
// Else, returns the result of the division
#[ensures((self@ == $type::MIN@ && rhs@ == -1) || result@ == self@ / rhs@)]
fn wrapping_div(self, rhs: $type) -> $type;
#[allow(dead_code)]
#[pure]
// Panics if the divisor is zero
#[requires(rhs@ != 0)]
// Returns `$type::MIN` if the division overflows
#[ensures((self@ == $type::MIN@ && rhs@ == -1) ==> result@ == $type::MIN@)]
// Else, returns the result of the division
#[ensures((self@ == $type::MIN@ && rhs@ == -1) || result@ == self@ / rhs@)]
fn saturating_div(self, rhs: $type) -> $type;
#[allow(dead_code)]
#[pure]
// Panics if the divisor is zero
#[requires(rhs@ != 0)]
// Returns `self` if the division overflows
#[ensures((self@ == $type::MIN@ && rhs@ == -1) ==> result.0@ == self@)]
// Else, returns the result of the division
#[ensures((self@ == $type::MIN@ && rhs@ == -1) || result.0@ == self@ / rhs@)]
// Overflow only occurs when computing `$type::MIN / -1`
#[ensures(result.1 == (self@ == $type::MIN@ && rhs@ == -1))]
fn overflowing_div(self, rhs: $type) -> ($type, bool);
}
}
};
}
/// Adds specifications for checked, wrapping, saturating, and overflowing versions of the given
/// operation on the given type. This only works for operations that have no additional pre- or
/// postconditions.
macro_rules! spec_op_common {
(
$type:ty,
$op:tt,
$checked:ident,
$wrapping:ident,
$saturating:ident,
$overflowing:ident $(,)?
) => {
extern_spec! {
impl $type {
// Checked: performs the operation on `Int`, returns `Some` if the result is between
// `$type::MIN` and `$type::MAX`, or `None` if the result cannot be represented by
// `$type`
#[allow(dead_code)]
#[pure]
// Returns `None` iff the result is out of range
#[ensures(
(result == None)
== ((self@ $op rhs@) < $type::MIN@ || (self@ $op rhs@) > $type::MAX@)
)]
// Returns `Some(result)` if the result is in range
#[ensures(forall<r: $type> result == Some(r) ==> r@ == (self@ $op rhs@))]
fn $checked(self, rhs: $type) -> Option<$type>;
// Wrapping: performs the operation on `Int` and converts back to `$type`
#[allow(dead_code)]
#[pure]
// Returns result converted to `$type`
#[ensures(
result@ == (self@ $op rhs@).rem_euclid(2.pow($type::BITS@)) + $type::MIN@
)]
// Returns the result if it is in range
#[ensures(
(self@ $op rhs@) >= $type::MIN@ && (self@ $op rhs@) <= $type::MAX@
==> result@ == (self@ $op rhs@)
)]
// Returns the result shifted by a multiple of the type's range if it is out of
// range. For addition and subtraction, `k` (qualified over below) will always be 1
// or -1, but the verifier is able to deduce that.
#[ensures(
(self@ $op rhs@) < $type::MIN@
==> exists<k: Int> k > 0
&& result@ == (self@ $op rhs@) + k * ($type::MAX@ - $type::MIN@ + 1)
)]
#[ensures(
(self@ $op rhs@) > $type::MAX@
==> exists<k: Int> k > 0
&& result@ == (self@ $op rhs@) - k * ($type::MAX@ - $type::MIN@ + 1)
)]
fn $wrapping(self, rhs: $type) -> $type;
// Saturating: performs the operation on `Int` and clamps the result between
// `$type::MIN` and `$type::MAX`
#[allow(dead_code)]
#[pure]
// Returns the result if it is in range
#[ensures(
(self@ $op rhs@) >= $type::MIN@ && (self@ $op rhs@) <= $type::MAX@
==> result@ == (self@ $op rhs@)
)]
// Returns the nearest bound if the result is out of range
#[ensures((self@ $op rhs@) < $type::MIN@ ==> result@ == $type::MIN@)]
#[ensures((self@ $op rhs@) > $type::MAX@ ==> result@ == $type::MAX@)]
fn $saturating(self, rhs: $type) -> $type;
// Overflowing: performs the operation on `Int` and converts back to `$type`, and
// indicates whether an overflow occurred
#[allow(dead_code)]
#[pure]
// Returns result converted to `$type`
#[ensures(
result.0@ == (self@ $op rhs@).rem_euclid(2.pow($type::BITS@)) + $type::MIN@
)]
// Returns the result if it is in range
#[ensures(
(self@ $op rhs@) >= $type::MIN@ && (self@ $op rhs@) <= $type::MAX@
==> result.0@ == (self@ $op rhs@)
)]
// Returns the result shifted by a multiple of the type's range if it is out of
// range. For addition and subtraction, `k` (qualified over below) will always be 1
// or -1, but the verifier is able to deduce that.
#[ensures(
(self@ $op rhs@) < $type::MIN@
==> exists<k: Int> k > 0
&& result.0@ == (self@ $op rhs@) + k * ($type::MAX@ - $type::MIN@ + 1)
)]
#[ensures(
(self@ $op rhs@) > $type::MAX@
==> exists<k: Int> k > 0
&& result.0@ == (self@ $op rhs@) - k * ($type::MAX@ - $type::MIN@ + 1)
)]
// Overflow occurred iff the result is out of range
#[ensures(
result.1 == ((self@ $op rhs@) < $type::MIN@ || (self@ $op rhs@) > $type::MAX@)
)]
fn $overflowing(self, rhs: $type) -> ($type, bool);
}
}
};
}
/// Adds specifications for the abs_diff operation on the given pair of signed
/// and unsigned integer types
macro_rules! spec_abs_diff {
($unsigned:ty, $signed:ty) => {
extern_spec! {
impl $unsigned {
#[allow(dead_code)]
#[pure]
#[ensures(result@ == self@.abs_diff(other@))]
fn abs_diff(self, other: $unsigned) -> $unsigned;
}
impl $signed {
#[allow(dead_code)]
#[pure]
#[ensures(result@ == self@.abs_diff(other@))]
fn abs_diff(self, other: $signed) -> $unsigned;
}
}
};
}
spec_type!(u8);
spec_type!(u16);
spec_type!(u32);
spec_type!(u64);
spec_type!(u128);
spec_type!(usize);
spec_type!(i8);
spec_type!(i16);
spec_type!(i32);
spec_type!(i64);
spec_type!(i128);
spec_type!(isize);
spec_abs_diff!(u8, i8);
spec_abs_diff!(u16, i16);
spec_abs_diff!(u32, i32);
spec_abs_diff!(u64, i64);
spec_abs_diff!(u128, i128);
spec_abs_diff!(usize, isize);