zksync_vm2 0.5.0

High-performance rewrite of the out-of-circuit VM for ZKsync Era
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

use primitive_types::U256;
use zksync_vm2_interface::{opcodes, HeapId, Tracer};

use super::{common::boilerplate_ext, ret::spontaneous_panic};
use crate::{
    addressing_modes::{Arguments, Destination, Register1, Register2, Source},
    instruction::ExecutionStatus,
    precompiles::{PrecompileMemoryReader, Precompiles},
    Instruction, VirtualMachine, World,
};

#[derive(Debug)]
struct PrecompileAuxData {
    extra_ergs_cost: u32,
    extra_pubdata_cost: u32,
}

impl PrecompileAuxData {
    #[allow(clippy::cast_possible_truncation)]
    fn from_u256(raw_value: U256) -> Self {
        let raw = raw_value.0;
        let extra_ergs_cost = raw[0] as u32;
        let extra_pubdata_cost = (raw[0] >> 32) as u32;

        Self {
            extra_ergs_cost,
            extra_pubdata_cost,
        }
    }
}

#[derive(Debug)]
struct PrecompileCallAbi {
    input_memory_offset: u32,
    input_memory_length: u32,
    output_memory_offset: u32,
    output_memory_length: u32,
    memory_page_to_read: HeapId,
    memory_page_to_write: HeapId,
    precompile_interpreted_data: u64,
}

impl PrecompileCallAbi {
    #[allow(clippy::cast_possible_truncation)]
    fn from_u256(raw_value: U256) -> Self {
        let raw = raw_value.0;
        let input_memory_offset = raw[0] as u32;
        let input_memory_length = (raw[0] >> 32) as u32;
        let output_memory_offset = raw[1] as u32;
        let output_memory_length = (raw[1] >> 32) as u32;
        let memory_page_to_read = HeapId::from_u32_unchecked(raw[2] as u32);
        let memory_page_to_write = HeapId::from_u32_unchecked((raw[2] >> 32) as u32);
        let precompile_interpreted_data = raw[3];

        Self {
            input_memory_offset,
            input_memory_length,
            output_memory_offset,
            output_memory_length,
            memory_page_to_read,
            memory_page_to_write,
            precompile_interpreted_data,
        }
    }
}

fn precompile_call<T: Tracer, W: World<T>>(
    vm: &mut VirtualMachine<T, W>,
    world: &mut W,
    tracer: &mut T,
) -> ExecutionStatus {
    boilerplate_ext::<opcodes::PrecompileCall, _, _>(
        vm,
        world,
        tracer,
        |vm, args, world, tracer| {
            // The user gets to decide how much gas to burn
            // This is safe because system contracts are trusted
            let aux_data = PrecompileAuxData::from_u256(Register2::get(args, &mut vm.state));
            let Ok(()) = vm.state.use_gas(aux_data.extra_ergs_cost) else {
                vm.state.current_frame.pc = spontaneous_panic();
                return;
            };

            #[allow(clippy::cast_possible_wrap)]
            {
                vm.world_diff.pubdata.0 += aux_data.extra_pubdata_cost as i32;
            }

            let mut abi = PrecompileCallAbi::from_u256(Register1::get(args, &mut vm.state));
            if abi.memory_page_to_read.as_u32() == 0 {
                abi.memory_page_to_read = vm.state.current_frame.heap;
            }
            if abi.memory_page_to_write.as_u32() == 0 {
                abi.memory_page_to_write = vm.state.current_frame.heap;
            }

            let address_bytes = vm.state.current_frame.address.0;
            let address_low = u16::from_le_bytes([address_bytes[19], address_bytes[18]]);
            let heap_to_read = &vm.state.heaps[abi.memory_page_to_read];
            let memory = PrecompileMemoryReader::new(
                heap_to_read,
                abi.input_memory_offset,
                abi.input_memory_length,
            );
            let output = world.precompiles().call_precompile(
                address_low,
                memory,
                abi.precompile_interpreted_data,
            );

            if let Some(cycle_stats) = output.cycle_stats {
                tracer.on_extra_prover_cycles(cycle_stats);
            }

            let mut write_offset = abi.output_memory_offset * 32;
            for i in 0..output.len.min(abi.output_memory_length) {
                vm.state.heaps.write_u256(
                    abi.memory_page_to_write,
                    write_offset,
                    output.buffer[i as usize],
                );
                write_offset += 32;
            }
            Register1::set(args, &mut vm.state, 1.into());
        },
    )
}

impl<T: Tracer, W: World<T>> Instruction<T, W> {
    /// Creates a [`PrecompileCall`](opcodes::PrecompileCall) instruction with the provided params.
    pub fn from_precompile_call(
        abi: Register1,
        burn: Register2,
        out: Register1,
        arguments: Arguments,
    ) -> Self {
        Self {
            arguments: arguments
                .write_source(&abi)
                .write_source(&burn)
                .write_destination(&out),
            handler: precompile_call,
        }
    }
}