cairo-lang-lowering 2.0.1

Cairo lowering phase.
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

use std::ops::Deref;

use cairo_lang_debug::DebugWithDb;
use cairo_lang_plugins::get_default_plugins;
use cairo_lang_semantic::db::SemanticGroup;
use cairo_lang_semantic::test_utils::setup_test_function;
use cairo_lang_utils::ordered_hash_map::OrderedHashMap;

use crate::add_withdraw_gas::add_withdraw_gas;
use crate::db::LoweringGroup;
use crate::destructs::add_destructs;
use crate::fmt::LoweredFormatter;
use crate::ids::ConcreteFunctionWithBodyId;
use crate::implicits::lower_implicits;
use crate::inline::apply_inlining;
use crate::optimizations::delay_var_def::delay_var_def;
use crate::optimizations::match_optimizer::optimize_matches;
use crate::optimizations::remappings::optimize_remappings;
use crate::panic::lower_panics;
use crate::reorganize_blocks::reorganize_blocks;
use crate::test_utils::LoweringDatabaseForTesting;
use crate::FlatLowered;
cairo_lang_test_utils::test_file_test!(
    lowering,
    "src/test_data",
    {
        assignment :"assignment",
        borrow_check :"borrow_check",
        call :"call",
        constant :"constant",
        destruct :"destruct",
        enums :"enums",
        error_propagate :"error_propagate",
        generics :"generics",
        extern_ :"extern",
        arm_pattern_destructure :"arm_pattern_destructure",
        if_ :"if",
        implicits :"implicits",
        logical_operator :"logical_operator",
        loop_ :"loop",
        match_ :"match",
        members :"members",
        panic :"panic",
        rebindings :"rebindings",
        snapshot :"snapshot",
        struct_ :"struct",
        tests :"tests",
        tuple :"tuple",
    },
    test_function_lowering
);

cairo_lang_test_utils::test_file_test!(
    lowering_phases,
    "src/test_data",
    {
        tests :"lowering_phases",
    },
    test_function_lowering_phases
);

fn test_function_lowering(
    inputs: &OrderedHashMap<String, String>,
) -> OrderedHashMap<String, String> {
    let db = &mut LoweringDatabaseForTesting::default();
    db.set_semantic_plugins(get_default_plugins());
    let (test_function, semantic_diagnostics) = setup_test_function(
        db,
        inputs["function"].as_str(),
        inputs["function_name"].as_str(),
        inputs["module_code"].as_str(),
    )
    .split();
    let function_id =
        ConcreteFunctionWithBodyId::from_semantic(db, test_function.concrete_function_id);

    let lowered = db.concrete_function_with_body_lowered(function_id);
    if let Ok(lowered) = &lowered {
        assert!(
            lowered.blocks.iter().all(|(_, b)| b.is_set()),
            "There should not be any unset flat blocks"
        );
    }
    let diagnostics = db.module_lowering_diagnostics(test_function.module_id).unwrap_or_default();
    let lowering_format =
        lowered.map(|lowered| formatted_lowered(db, &lowered)).unwrap_or_default();

    OrderedHashMap::from([
        ("semantic_diagnostics".into(), semantic_diagnostics),
        ("lowering_diagnostics".into(), diagnostics.format(db)),
        ("lowering_flat".into(), lowering_format),
    ])
}

/// Tests all the lowering phases of a function (tracking logic in
/// `concrete_function_with_body_lowered`).
/// Can be used to debug cases where the transition of a specific lowering phase fails.
fn test_function_lowering_phases(
    inputs: &OrderedHashMap<String, String>,
) -> OrderedHashMap<String, String> {
    let mut db = LoweringDatabaseForTesting::default();
    db.set_semantic_plugins(get_default_plugins());

    let (test_function, semantic_diagnostics) = setup_test_function(
        &mut db,
        inputs["function"].as_str(),
        inputs["function_name"].as_str(),
        inputs["module_code"].as_str(),
    )
    .split();
    let function_id =
        ConcreteFunctionWithBodyId::from_semantic(&db, test_function.concrete_function_id);

    let before_all = db.priv_concrete_function_with_body_lowered_flat(function_id).unwrap();
    assert!(
        before_all.blocks.iter().all(|(_, b)| b.is_set()),
        "There should not be any unset blocks"
    );

    let mut after_inlining = before_all.deref().clone();
    apply_inlining(&db, function_id, &mut after_inlining).unwrap();

    let mut after_add_withdraw_gas = after_inlining.clone();
    add_withdraw_gas(&db, function_id, &mut after_add_withdraw_gas).unwrap();

    let after_lower_panics = lower_panics(&db, function_id, &after_add_withdraw_gas).unwrap();

    let mut after_add_destructs = after_lower_panics.clone();
    add_destructs(&db, function_id, &mut after_add_destructs);

    let mut after_optimize_remappings1 = after_add_destructs.clone();
    optimize_remappings(&mut after_optimize_remappings1);

    let mut after_delay_var_def1 = after_optimize_remappings1.clone();
    delay_var_def(&mut after_delay_var_def1);

    let mut after_optimize_matches = after_delay_var_def1.clone();
    optimize_matches(&mut after_optimize_matches);

    let mut after_lower_implicits = after_optimize_matches.clone();
    lower_implicits(&db, function_id, &mut after_lower_implicits);

    let mut after_optimize_remappings2 = after_lower_implicits.clone();
    optimize_remappings(&mut after_optimize_remappings2);

    let mut after_delay_var_def2 = after_optimize_remappings2.clone();
    delay_var_def(&mut after_delay_var_def2);

    let mut after_reorganize_blocks = after_delay_var_def2.clone();
    reorganize_blocks(&mut after_reorganize_blocks);

    let after_all = db.concrete_function_with_body_lowered(function_id).unwrap();

    // This asserts that we indeed follow the logic of `concrete_function_with_body_lowered`.
    // If something is changed there, it should be changed here too.
    assert_eq!(*after_all, after_reorganize_blocks);

    let diagnostics = db.module_lowering_diagnostics(test_function.module_id).unwrap();

    OrderedHashMap::from([
        ("semantic_diagnostics".into(), semantic_diagnostics),
        ("lowering_diagnostics".into(), diagnostics.format(&db)),
        ("before_all".into(), formatted_lowered(&db, &before_all)),
        ("after_inlining".into(), formatted_lowered(&db, &after_inlining)),
        ("after_add_withdraw_gas".into(), formatted_lowered(&db, &after_add_withdraw_gas)),
        ("after_lower_panics".into(), formatted_lowered(&db, &after_lower_panics)),
        ("after_add_destructs".into(), formatted_lowered(&db, &after_add_destructs)),
        ("after_optimize_remappings1".into(), formatted_lowered(&db, &after_optimize_remappings1)),
        ("after_delay_var_def1".into(), formatted_lowered(&db, &after_delay_var_def1)),
        ("after_optimize_matches".into(), formatted_lowered(&db, &after_optimize_matches)),
        ("after_lower_implicits".into(), formatted_lowered(&db, &after_lower_implicits)),
        ("after_optimize_remappings2".into(), formatted_lowered(&db, &after_optimize_remappings2)),
        ("after_delay_var_def2".into(), formatted_lowered(&db, &after_delay_var_def2)),
        (
            "after_reorganize_blocks (final)".into(),
            formatted_lowered(&db, &after_reorganize_blocks),
        ),
    ])
}

fn formatted_lowered(db: &dyn LoweringGroup, lowered: &FlatLowered) -> String {
    let lowered_formatter = LoweredFormatter { db, variables: &lowered.variables };
    format!("{:?}", lowered.debug(&lowered_formatter))
}