midenc-hir 0.8.1

High-level Intermediate Representation for Miden Assembly
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

pub use midenc_hir_macros::{
    Dialect, DialectAttribute, DialectRegistration, EffectOpInterface, OpParser, OpPrinter,
    operation, operation_trait,
};

#[cfg(test)]
mod tests {
    use alloc::format;

    use midenc_session::diagnostics::Severity;

    use crate::{
        BuilderExt, Context, Op, Operation, Report, Spanned, Value, ValueRef,
        derive::operation_trait,
        dialects::{
            builtin::attributes::Overflow,
            test::{self, Add},
        },
        pass::{Nesting, PassManager},
        testing::Test,
    };

    /// A marker trait for arithmetic ops
    #[operation_trait]
    trait ArithmeticOp {
        #[verifier]
        fn is_binary_op(op: &Operation, ctx: &Context) -> Result<(), Report> {
            if op.num_operands() == 2 {
                Ok(())
            } else {
                Err(ctx
                    .diagnostics()
                    .diagnostic(Severity::Error)
                    .with_message("invalid operation")
                    .with_primary_label(
                        op.span(),
                        format!(
                            "incorrect number of operands, expected 2, got {}",
                            op.num_operands()
                        ),
                    )
                    .with_help(
                        "this operator implements 'ArithmeticOp' which requires ops to be binary",
                    )
                    .into_report())
            }
        }
    }

    impl ArithmeticOp for Add {}

    inventory::submit!(crate::DialectRegistrationHookInfo::new::<test::TestDialect>(
        register_arithmetic_op_trait
    ));

    fn register_arithmetic_op_trait(info: &mut crate::DialectInfo) {
        info.register_operation_trait::<Add, dyn ArithmeticOp>();
    }

    #[test]
    fn derived_op_builder_test() {
        use crate::{SourceSpan, Type};

        let mut test = Test::new("derived_op_builder", &[Type::U32, Type::U32], &[]);

        let entry = test.entry_block();
        let (lhs, rhs) = {
            let block = entry.borrow();
            let lhs = block.get_argument(0) as ValueRef;
            let rhs = block.get_argument(1) as ValueRef;
            (lhs, rhs)
        };
        let builder = test.builder_mut();
        let add_builder = builder.create::<Add, _>(SourceSpan::default());
        let op = add_builder(lhs, rhs, Overflow::Wrapping);
        let op = op.expect("failed to create AddOp");
        let op = op.borrow();
        assert!(op.as_operation().implements::<dyn ArithmeticOp>());
        assert!(core::hint::black_box(
            !<Add as crate::verifier::Verifier<dyn ArithmeticOp>>::VACUOUS
        ));
    }

    #[test]
    #[should_panic = "expected 'u32', got 'i64'"]
    fn derived_op_verifier_test() {
        use crate::{SourceSpan, Type};

        let mut test = Test::new("derived_op_verifier", &[Type::U32, Type::I64], &[]);

        let entry = test.entry_block();
        let (lhs, invalid_rhs) = {
            let block = entry.borrow();
            let lhs = block.get_argument(0) as ValueRef;
            let rhs = block.get_argument(1) as ValueRef;
            (lhs, rhs)
        };

        // Try to create instance of AddOp with mismatched operand types
        let add_builder = test.builder_mut().create::<Add, _>(SourceSpan::default());
        let op = add_builder(lhs, invalid_rhs, Overflow::Wrapping);
        let op = op.unwrap();

        // Construct a pass manager with the default pass pipeline
        let mut pm = PassManager::on::<Add>(test.context_rc(), Nesting::Implicit);
        // Run pass pipeline
        pm.run(op.as_operation_ref()).unwrap();
    }

    /// Fails if [`InvalidOpsWithReturn`] is created successfully. [`InvalidOpsWithReturn`] is a
    /// struct that has differing types in its result and arguments, despite implementing the
    /// [`SameOperandsAndResultType`] trait.
    #[test]
    #[should_panic = "expected 'i32', got 'u64'"]
    fn same_operands_and_result_type_verifier_test() {
        use crate::{SourceSpan, Type};

        let mut test =
            Test::new("same_operands_and_result_type_verifier", &[Type::I32, Type::I32], &[]);
        let block = test.entry_block();
        let (lhs, rhs) = {
            let block = block.borrow();
            let lhs = block.get_argument(0) as ValueRef;
            let rhs = block.get_argument(1) as ValueRef;
            (lhs, rhs)
        };

        let add_builder = test.builder_mut().create::<Add, _>(SourceSpan::default());
        let op = add_builder(lhs, rhs, Overflow::Wrapping);
        let mut op = op.unwrap();

        // NOTE: We override the result's type in order to force the SameOperandsAndResultType
        // verification function to trigger an error
        {
            let mut binding = op.borrow_mut();
            let mut result = binding.result_mut();
            result.set_type(Type::U64);
        }

        // Construct a pass manager with the default pass pipeline
        let mut pm = PassManager::on::<Add>(test.context_rc(), Nesting::Implicit);
        // Run pass pipeline
        pm.run(op.as_operation_ref()).unwrap();
    }
}