leo-passes 3.0.0

Compiler passes for the Leo programming language
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

// Copyright (C) 2019-2025 Provable Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

use leo_ast::{Expression::Literal, *};

use leo_errors::LoopUnrollerError;

use super::UnrollingVisitor;

impl AstReconstructor for UnrollingVisitor<'_> {
    type AdditionalOutput = ();

    /* Expressions */
    fn reconstruct_repeat(&mut self, input: RepeatExpression) -> (Expression, Self::AdditionalOutput) {
        // Because the value of `count` affects the type of a repeat expression, we need to assign a new ID to the
        // reconstructed `RepeatExpression` and update the type table accordingly.
        let new_id = self.state.node_builder.next_id();
        let new_count = self.reconstruct_expression(input.count).0;
        let el_ty = self.state.type_table.get(&input.expr.id()).expect("guaranteed by type checking");
        self.state.type_table.insert(new_id, Type::Array(ArrayType::new(el_ty, new_count.clone())));
        (
            RepeatExpression { expr: self.reconstruct_expression(input.expr).0, count: new_count, id: new_id, ..input }
                .into(),
            Default::default(),
        )
    }

    fn reconstruct_block(&mut self, mut input: Block) -> (Block, Self::AdditionalOutput) {
        self.in_scope(input.id(), |slf| {
            input.statements = input.statements.into_iter().map(|stmt| slf.reconstruct_statement(stmt).0).collect();

            (input, Default::default())
        })
    }

    fn reconstruct_const(&mut self, input: ConstDeclaration) -> (Statement, Self::AdditionalOutput) {
        (input.into(), Default::default())
    }

    fn reconstruct_definition(&mut self, input: DefinitionStatement) -> (Statement, Self::AdditionalOutput) {
        (
            DefinitionStatement {
                type_: input.type_.map(|ty| self.reconstruct_type(ty).0),
                value: self.reconstruct_expression(input.value).0,
                ..input
            }
            .into(),
            Default::default(),
        )
    }

    fn reconstruct_iteration(&mut self, input: IterationStatement) -> (Statement, Self::AdditionalOutput) {
        // There's no need to reconstruct the bound expressions - they must be constants
        // which can be evaluated through constant propagation.

        let Literal(start_lit_ref) = &input.start else {
            self.loop_not_unrolled = Some(input.start.span());
            return (Statement::Iteration(Box::new(input)), Default::default());
        };

        let Literal(stop_lit_ref) = &input.stop else {
            self.loop_not_unrolled = Some(input.stop.span());
            return (Statement::Iteration(Box::new(input)), Default::default());
        };

        // Helper to clone and resolve Unsuffixed -> Integer literal based on type table
        let resolve_unsuffixed = |lit: &leo_ast::Literal, expr_id| {
            let mut resolved = lit.clone();
            if let LiteralVariant::Unsuffixed(s) = &resolved.variant {
                if let Some(Type::Integer(integer_type)) = self.state.type_table.get(&expr_id) {
                    resolved.variant = LiteralVariant::Integer(integer_type, s.clone());
                }
            }
            resolved
        };

        // Clone and resolve both literals
        let resolved_start_lit = resolve_unsuffixed(start_lit_ref, input.start.id());
        let resolved_stop_lit = resolve_unsuffixed(stop_lit_ref, input.stop.id());

        // Convert resolved literals into constant values
        let start_value = Value::try_from(&resolved_start_lit).unwrap();
        let stop_value = Value::try_from(&resolved_stop_lit).unwrap();

        // Ensure loop bounds are strictly increasing
        let bounds_invalid = match (&start_value, &stop_value) {
            (Value::I8(a, _), Value::I8(b, _)) => a >= b,
            (Value::I16(a, _), Value::I16(b, _)) => a >= b,
            (Value::I32(a, _), Value::I32(b, _)) => a >= b,
            (Value::I64(a, _), Value::I64(b, _)) => a >= b,
            (Value::I128(a, _), Value::I128(b, _)) => a >= b,
            (Value::U8(a, _), Value::U8(b, _)) => a >= b,
            (Value::U16(a, _), Value::U16(b, _)) => a >= b,
            (Value::U32(a, _), Value::U32(b, _)) => a >= b,
            (Value::U64(a, _), Value::U64(b, _)) => a >= b,
            (Value::U128(a, _), Value::U128(b, _)) => a >= b,
            _ => panic!("Type checking guarantees that loop bounds are integers of the same type."),
        };

        if bounds_invalid {
            self.emit_err(LoopUnrollerError::loop_range_decreasing(input.stop.span()));
        }

        self.loop_unrolled = true;

        // Perform loop unrolling using i128 — all numeric bounds are converted to this internally
        (self.unroll_iteration_statement::<i128>(input, start_value, stop_value), Default::default())
    }
}