solana-syscalls 4.4.0-alpha.3

Solana syscalls.
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

use {
    super::*, solana_program_runtime::memory::translate_vm_slice, solana_sbpf::vm::ContextObject,
};

/// Log a user's info message
pub struct SyscallLog {}
impl BuiltinFunctionDefinition<InvokeContext<'_, '_>> for SyscallLog {
    type Error = Error;
    fn rust(
        invoke_context: &mut InvokeContext<'_, '_>,
        addr: u64,
        len: u64,
        _arg3: u64,
        _arg4: u64,
        _arg5: u64,
    ) -> Result<u64, Error> {
        let cost = invoke_context
            .get_execution_cost()
            .syscall_base_cost
            .max(len);
        invoke_context.compute_meter.consume_checked(cost)?;

        let check_aligned = invoke_context.get_check_aligned();
        let memory_mapping = invoke_context.memory_contexts.memory_mapping()?;
        translate_string_and_do(
            memory_mapping,
            addr,
            len,
            check_aligned,
            &mut |string: &str| {
                stable_log::program_log(&invoke_context.get_log_collector(), string);
                Ok(0)
            },
        )?;
        Ok(0)
    }
}

/// Log 5 64-bit values
pub struct SyscallLogU64 {}
impl BuiltinFunctionDefinition<InvokeContext<'_, '_>> for SyscallLogU64 {
    type Error = Error;
    fn rust(
        invoke_context: &mut InvokeContext<'_, '_>,
        arg1: u64,
        arg2: u64,
        arg3: u64,
        arg4: u64,
        arg5: u64,
    ) -> Result<u64, Error> {
        let cost = invoke_context.get_execution_cost().log_64_units;
        invoke_context.compute_meter.consume_checked(cost)?;

        stable_log::program_log(
            &invoke_context.get_log_collector(),
            &format!("{arg1:#x}, {arg2:#x}, {arg3:#x}, {arg4:#x}, {arg5:#x}"),
        );
        Ok(0)
    }
}

/// Log current compute consumption
pub struct SyscallLogBpfComputeUnits {}
impl BuiltinFunctionDefinition<InvokeContext<'_, '_>> for SyscallLogBpfComputeUnits {
    type Error = Error;
    fn rust(
        invoke_context: &mut InvokeContext<'_, '_>,
        _arg1: u64,
        _arg2: u64,
        _arg3: u64,
        _arg4: u64,
        _arg5: u64,
    ) -> Result<u64, Error> {
        let cost = invoke_context.get_execution_cost().syscall_base_cost;
        invoke_context.compute_meter.consume_checked(cost)?;

        ic_logger_msg!(
            invoke_context.get_log_collector(),
            "Program consumption: {} units remaining",
            invoke_context.get_remaining(),
        );
        Ok(0)
    }
}

/// Log a [`Pubkey`] as a base58 string
pub struct SyscallLogPubkey {}
impl BuiltinFunctionDefinition<InvokeContext<'_, '_>> for SyscallLogPubkey {
    type Error = Error;
    fn rust(
        invoke_context: &mut InvokeContext<'_, '_>,
        pubkey_addr: u64,
        _arg2: u64,
        _arg3: u64,
        _arg4: u64,
        _arg5: u64,
    ) -> Result<u64, Error> {
        let cost = invoke_context.get_execution_cost().log_pubkey_units;
        invoke_context.compute_meter.consume_checked(cost)?;

        let check_aligned = invoke_context.get_check_aligned();
        let memory_mapping = invoke_context.memory_contexts.memory_mapping()?;
        let pubkey = translate_type::<Pubkey>(memory_mapping, pubkey_addr, check_aligned)?;
        stable_log::program_log(&invoke_context.get_log_collector(), &pubkey.to_string());
        Ok(0)
    }
}

/// Log data handling
pub struct SyscallLogData {}
impl BuiltinFunctionDefinition<InvokeContext<'_, '_>> for SyscallLogData {
    type Error = Error;
    fn rust(
        invoke_context: &mut InvokeContext<'_, '_>,
        addr: u64,
        len: u64,
        _arg3: u64,
        _arg4: u64,
        _arg5: u64,
    ) -> Result<u64, Error> {
        let execution_cost = invoke_context.get_execution_cost();

        invoke_context
            .compute_meter
            .consume_checked(execution_cost.syscall_base_cost)?;

        let check_aligned = invoke_context.get_check_aligned();
        let memory_mapping = invoke_context.memory_contexts.memory_mapping()?;
        let untranslated_fields =
            translate_slice::<VmSlice<u8>>(memory_mapping, addr, len, check_aligned)?;

        let cost = execution_cost
            .syscall_base_cost
            .saturating_mul(untranslated_fields.len() as u64);
        invoke_context.compute_meter.consume_checked(cost)?;
        let cost = untranslated_fields
            .iter()
            .fold(0u64, |total, e| total.saturating_add(e.len()));
        invoke_context.compute_meter.consume_checked(cost)?;

        let mut fields = Vec::with_capacity(untranslated_fields.len());

        for untranslated_field in untranslated_fields {
            fields.push(translate_vm_slice(
                untranslated_field,
                memory_mapping,
                check_aligned,
            )?);
        }

        let log_collector = invoke_context.get_log_collector();

        stable_log::program_data(&log_collector, &fields);

        Ok(0)
    }
}