cairo-lang-sierra 2.19.2

Sierra representation.
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

use crate::define_libfunc_hierarchy;
use crate::extensions::lib_func::{
    LibfuncSignature, SierraApChange, SignatureSpecializationContext,
};
use crate::extensions::{NoGenericArgsGenericLibfunc, SpecializationError};

define_libfunc_hierarchy! {
    pub enum ApTrackingLibfunc {
        Revoke(RevokeApTrackingLibfunc),
        Enable(EnableApTrackingLibfunc),
        Disable(DisableApTrackingLibfunc),
    }, ApTrackingConcreteLibfunc
}

/// Revoke the AP tracking.
/// This libfunc changes `ap_tracking` state to unknown,
/// allowing a path with known ap tracking to converge with a path with unknown AP tracking.
#[derive(Default)]
pub struct RevokeApTrackingLibfunc {}
impl NoGenericArgsGenericLibfunc for RevokeApTrackingLibfunc {
    const STR_ID: &'static str = "revoke_ap_tracking";

    fn specialize_signature(
        &self,
        _context: &dyn SignatureSpecializationContext,
    ) -> Result<LibfuncSignature, SpecializationError> {
        Ok(LibfuncSignature::new_non_branch(vec![], vec![], SierraApChange::Unknown))
    }
}

/// Enable AP tracking.
/// This Libfunc is used to enable AP tracking to allow branches that may diverge and merge after
/// this point to have an aligned AP.
#[derive(Default)]
pub struct EnableApTrackingLibfunc {}
impl NoGenericArgsGenericLibfunc for EnableApTrackingLibfunc {
    const STR_ID: &'static str = "enable_ap_tracking";

    fn specialize_signature(
        &self,
        _context: &dyn SignatureSpecializationContext,
    ) -> Result<LibfuncSignature, SpecializationError> {
        Ok(LibfuncSignature::new_non_branch(
            vec![],
            vec![],
            SierraApChange::Known { new_vars_only: true },
        ))
    }
}

/// Disable AP tracking.
/// This Libfunc is used to disable ap tracking to allow merging branches that some have unknown ap
/// change, without actually revoking the local stack.
#[derive(Default)]
pub struct DisableApTrackingLibfunc {}
impl NoGenericArgsGenericLibfunc for DisableApTrackingLibfunc {
    const STR_ID: &'static str = "disable_ap_tracking";

    fn specialize_signature(
        &self,
        _context: &dyn SignatureSpecializationContext,
    ) -> Result<LibfuncSignature, SpecializationError> {
        Ok(LibfuncSignature::new_non_branch(
            vec![],
            vec![],
            SierraApChange::Known { new_vars_only: true },
        ))
    }
}