llzk 0.5.0

Rust bindings to the LLZK C API.
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

use crate::{error::Error, ident};

use super::FeltConstAttribute;
use melior::ir::{
    Location, Operation, Type, Value, ValueLike as _,
    operation::{OperationBuilder, OperationLike},
};

fn build_op<'c>(
    name: &str,
    location: Location<'c>,
    result: Type<'c>,
    operands: &[Value<'c, '_>],
) -> Result<Operation<'c>, Error> {
    OperationBuilder::new(format!("felt.{name}").as_str(), location)
        .add_results(&[result])
        .add_operands(operands)
        .build()
        .map_err(Into::into)
}

macro_rules! binop {
    ($name:ident) => {
        binop!($name, stringify!($name));
    };
    ($name:ident, $opname:expr) => {
        #[doc = concat!("Creates a `felt.", $opname ,"` operation.")]
        pub fn $name<'c>(
            location: Location<'c>,
            lhs: Value<'c, '_>,
            rhs: Value<'c, '_>,
        ) -> Result<Operation<'c>, Error> {
            build_op($opname, location, lhs.r#type(), &[lhs, rhs])
        }

        paste::paste! {
            #[doc = concat!("Return `true` iff the given op is `felt.", $opname ,"`.")]
            #[inline]
            pub fn [<is_felt_ $name>]<'c: 'a, 'a>(op: &impl OperationLike<'c, 'a>) -> bool {
                crate::operation::isa(op, concat!("felt.", $opname))
            }
        }
    };
}

macro_rules! unop {
    ($name:ident) => {
        unop!($name, stringify!($name));
    };
    ($name:ident, $opname:expr) => {
        #[doc = concat!("Creates a `felt.", $opname ,"` operation.")]
        pub fn $name<'c>(
            location: Location<'c>,
            value: Value<'c, '_>,
        ) -> Result<Operation<'c>, Error> {
            build_op($opname, location, value.r#type(), &[value])
        }

        paste::paste! {
            #[doc = concat!("Return `true` iff the given op is `felt.", $opname ,"`.")]
            #[inline]
            pub fn [<is_felt_ $name>]<'c: 'a, 'a>(op: &impl OperationLike<'c, 'a>) -> bool {
                crate::operation::isa(op, concat!("felt.", $opname))
            }
        }
    };
}

binop!(add);
binop!(bit_and);
binop!(bit_or);
binop!(bit_xor);
binop!(div);
binop!(mul);
binop!(pow);
binop!(shl);
binop!(shr);
binop!(sintdiv);
binop!(smod);
binop!(sub);
binop!(uintdiv);
binop!(umod);
unop!(bit_not);
unop!(inv);
unop!(neg);

/// Creates a `felt.const` operation.
pub fn constant<'c>(
    location: Location<'c>,
    value: FeltConstAttribute<'c>,
) -> Result<Operation<'c>, Error> {
    let ctx = location.context();
    OperationBuilder::new("felt.const", location)
        .add_results(&[value.r#type().into()])
        .add_attributes(&[(ident!(ctx, "value"), value.into())])
        .build()
        .map_err(Into::into)
}

/// Return `true` iff the given op is `felt.const`.
#[inline]
pub fn is_felt_const<'c: 'a, 'a>(op: &impl OperationLike<'c, 'a>) -> bool {
    crate::operation::isa(op, "felt.const")
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::prelude::*;
    use quickcheck_macros::quickcheck;

    #[quickcheck]
    fn felt_const_op(value: u64) {
        // ensure value fits in i64, which is what's internally used by FeltConstAttribute
        let value = value % (i64::MAX as u64 + 1);
        let ctx = LlzkContext::new();
        let op = constant(
            Location::unknown(&ctx),
            FeltConstAttribute::new(&ctx, value, None),
        )
        .unwrap();
        assert!(op.verify(), "operation {op:?} failed verification");
    }

    #[quickcheck]
    fn felt_const_op_isa(value: u64) {
        // ensure value fits in i64, which is what's internally used by FeltConstAttribute
        let value = value % (i64::MAX as u64 + 1);
        let ctx = LlzkContext::new();
        let op = constant(
            Location::unknown(&ctx),
            FeltConstAttribute::new(&ctx, value, None),
        )
        .unwrap();
        assert!(is_felt_const(&op), "operation {op:?} failed isa test");
    }
}