cairo-lang-lowering 2.17.0

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

use cairo_lang_debug::DebugWithDb;
use cairo_lang_semantic::test_utils::setup_test_function;
use cairo_lang_test_utils::parse_test_file::TestRunnerResult;
use cairo_lang_utils::ordered_hash_map::OrderedHashMap;

use crate::LoweringStage;
use crate::db::LoweringGroup;
use crate::fmt::LoweredFormatter;
use crate::ids::ConcreteFunctionWithBodyId;
use crate::optimizations::reboxing::{apply_reboxing_candidates, find_reboxing_candidates};
use crate::optimizations::strategy::OptimizationPhase;
use crate::test_utils::LoweringDatabaseForTesting;

cairo_lang_test_utils::test_file_test!(
    reboxing_analysis,
    "src/optimizations/test_data",
    {
        reboxing: "reboxing",
    },
    test_reboxing_analysis
);

fn test_reboxing_analysis(
    inputs: &OrderedHashMap<String, String>,
    _args: &OrderedHashMap<String, String>,
) -> TestRunnerResult {
    let db = &mut LoweringDatabaseForTesting::default();
    let (test_function, semantic_diagnostics) = setup_test_function(db, inputs).split();

    let function_id =
        ConcreteFunctionWithBodyId::from_semantic(db, test_function.concrete_function_id);
    if let Ok(mut before) = db.lowered_body(function_id, LoweringStage::PreOptimizations).cloned() {
        OptimizationPhase::ApplyInlining { enable_const_folding: true }
            .apply(db, function_id, &mut before)
            .unwrap();
        OptimizationPhase::ReorganizeBlocks.apply(db, function_id, &mut before).unwrap();

        OptimizationPhase::ReorderStatements.apply(db, function_id, &mut before).unwrap();
        let mut after = before.clone();

        let formatter = LoweredFormatter::new(db, &after.variables);
        trace!("Lowering input to Reboxing:\n{:?}", after.debug(&formatter));

        let candidates = find_reboxing_candidates(&after);

        let candidates_str = candidates
            .iter()
            .map(|v| format!("v{}", v.reboxed_var.index()))
            .collect::<Vec<_>>()
            .join(", ");

        // Apply reboxing optimizations to create "after" state
        apply_reboxing_candidates(db, &mut after, &candidates).unwrap();

        TestRunnerResult::success(OrderedHashMap::from([
            ("candidates".into(), candidates_str),
            (
                "before".into(),
                format!("{:?}", before.debug(&LoweredFormatter::new(db, &before.variables))),
            ),
            (
                "after".into(),
                format!("{:?}", after.debug(&LoweredFormatter::new(db, &after.variables))),
            ),
        ]))
    } else {
        let lowering_diags =
            db.module_lowering_diagnostics(test_function.module_id).map_or("".to_string(), |d| {
                d.get_all().iter().map(|d| format!("{d:?}")).collect::<Vec<_>>().join("\n")
            });
        panic!(
            "Unexpected diagnostics:\nSemantic:\n{}\nLowering:\n{}",
            semantic_diagnostics, lowering_diags
        );
    }
}