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
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

use cairo_lang_diagnostics::Maybe;
use cairo_lang_utils::ordered_hash_set::OrderedHashSet;
use salsa::Database;

use crate::db::{LoweringGroup, get_direct_callees};
use crate::ids::{
    ConcreteFunctionWithBodyId, FunctionId, FunctionWithBodyId, GenericOrSpecialized,
};
use crate::{DependencyType, LoweringStage};

/// Query implementation of
/// [crate::db::LoweringGroup::function_with_body_direct_callees].
#[salsa::tracked(returns(ref))]
pub fn function_with_body_direct_callees<'db>(
    db: &'db dyn Database,
    function_id: FunctionWithBodyId<'db>,
    dependency_type: DependencyType,
) -> Maybe<OrderedHashSet<FunctionId<'db>>> {
    let lowered = db.function_with_body_lowering(function_id)?;
    let bc = db.borrow_check(function_id)?;
    Ok(get_direct_callees(db, lowered, dependency_type, &bc.block_extra_calls)
        .into_iter()
        .collect())
}

/// Query implementation of
/// [crate::db::LoweringGroup::function_with_body_direct_function_with_body_callees].
#[salsa::tracked(returns(ref))]
pub fn function_with_body_direct_function_with_body_callees<'db>(
    db: &'db dyn Database,
    function_id: FunctionWithBodyId<'db>,
    dependency_type: DependencyType,
) -> Maybe<OrderedHashSet<FunctionWithBodyId<'db>>> {
    Ok(db
        .function_with_body_direct_callees(function_id, dependency_type)?
        .into_iter()
        .map(|function_id| function_id.body(db))
        .collect::<Maybe<Vec<Option<_>>>>()?
        .into_iter()
        .flatten()
        .map(|x| match x.generic_or_specialized(db) {
            GenericOrSpecialized::Generic(id) => id,
            GenericOrSpecialized::Specialized(_) => {
                unreachable!("Specialization of functions only occurs post concretization.")
            }
        })
        .collect())
}

/// Query implementation of [LoweringGroup::final_contains_call_cycle].
#[salsa::tracked(cycle_result=final_contains_call_cycle_handle_cycle)]
pub fn final_contains_call_cycle<'db>(
    db: &'db dyn Database,
    function_id: ConcreteFunctionWithBodyId<'db>,
) -> Maybe<bool> {
    let direct_callees = db.lowered_direct_callees_with_body(
        function_id,
        DependencyType::Call,
        LoweringStage::Final,
    )?;
    for callee in direct_callees {
        if db.final_contains_call_cycle(*callee)? {
            return Ok(true);
        }
    }

    Ok(false)
}

/// Cycle handling for [LoweringGroup::final_contains_call_cycle].
pub fn final_contains_call_cycle_handle_cycle<'db>(
    _db: &'db dyn Database,
    _id: salsa::Id,
    _function_id: ConcreteFunctionWithBodyId<'db>,
) -> Maybe<bool> {
    Ok(true)
}

/// Query implementation of [LoweringGroup::in_cycle].
#[salsa::tracked]
pub fn in_cycle<'db>(
    db: &'db dyn Database,
    function_id: FunctionWithBodyId<'db>,
    dependency_type: DependencyType,
) -> Maybe<bool> {
    if db
        .function_with_body_direct_function_with_body_callees(function_id, dependency_type)?
        .contains(&function_id)
    {
        return Ok(true);
    }
    Ok(db.function_with_body_scc(function_id, dependency_type).len() > 1)
}

/// Query implementation of [LoweringGroup::concrete_in_cycle].
#[salsa::tracked]
pub fn concrete_in_cycle<'db>(
    db: &'db dyn Database,
    function_id: ConcreteFunctionWithBodyId<'db>,
    dependency_type: DependencyType,
    stage: LoweringStage,
) -> Maybe<bool> {
    if db
        .lowered_direct_callees_with_body(function_id, dependency_type, stage)?
        .contains(&function_id)
    {
        return Ok(true);
    }
    Ok(db.lowered_scc(function_id, dependency_type, stage).len() > 1)
}