sp1-core-machine 6.0.0-beta.1

SP1 is a performant, 100% open-source, contributor-friendly zkVM.
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

use crate::air::WordAirBuilder;
use serde::{Deserialize, Serialize};
use slop_algebra::{AbstractField, Field};
use sp1_core_executor::{events::ByteRecord, ByteOpcode};
use sp1_derive::{AlignedBorrow, InputExpr, InputParams, IntoShape, SP1OperationBuilder};
use sp1_hypercube::air::SP1AirBuilder;

use crate::air::SP1Operation;

/// A set of columns to describe the state of the CPU.
/// The state is composed of the shard, clock, and the program counter.
/// The clock is split into 24 bits, 8 bits, 16 bits limbs.
#[derive(
    AlignedBorrow,
    Default,
    Debug,
    Clone,
    Copy,
    Serialize,
    Deserialize,
    IntoShape,
    SP1OperationBuilder,
)]
#[repr(C)]
pub struct CPUState<T> {
    pub clk_high: T,
    pub clk_16_24: T,
    pub clk_0_16: T,
    pub pc: [T; 3],
}

impl<T: Copy> CPUState<T> {
    pub fn clk_high<AB>(&self) -> AB::Expr
    where
        AB: SP1AirBuilder<Var = T>,
        T: Into<AB::Expr>,
    {
        self.clk_high.into()
    }
    pub fn clk_low<AB>(&self) -> AB::Expr
    where
        AB: SP1AirBuilder<Var = T>,
        T: Into<AB::Expr>,
    {
        self.clk_0_16.into() + self.clk_16_24.into() * AB::Expr::from_canonical_u32(1 << 16)
    }
}

impl<F: Field> CPUState<F> {
    #[allow(clippy::too_many_arguments)]
    pub fn populate(&mut self, blu_events: &mut impl ByteRecord, clk: u64, pc: u64) {
        let clk_high = (clk >> 24) as u32;
        let clk_16_24 = ((clk >> 16) & 0xFF) as u8;
        let clk_0_16 = (clk & 0xFFFF) as u16;
        self.clk_high = F::from_canonical_u32(clk_high);
        self.clk_16_24 = F::from_canonical_u8(clk_16_24);
        self.clk_0_16 = F::from_canonical_u16(clk_0_16);
        self.pc = [
            F::from_canonical_u16((pc & 0xFFFF) as u16),
            F::from_canonical_u16(((pc >> 16) & 0xFFFF) as u16),
            F::from_canonical_u16(((pc >> 32) & 0xFFFF) as u16),
        ];

        // 0 <= (clk_0_16 - 1) / 8 < 2^13 shows clk == 1 (mod 8) and clk_0_16 is 16 bits.
        blu_events.add_bit_range_check((clk_0_16 - 1) / 8, 13);
        blu_events.add_u8_range_checks(&[clk_16_24, 0]);
    }

    #[allow(clippy::too_many_arguments)]
    pub fn eval<AB: SP1AirBuilder>(
        builder: &mut AB,
        cols: CPUState<AB::Var>,
        next_pc: [AB::Expr; 3],
        clk_increment: AB::Expr,
        is_real: AB::Expr,
    ) {
        let clk_high = cols.clk_high::<AB>();
        let clk_low = cols.clk_low::<AB>();
        builder.assert_bool(is_real.clone());
        builder.receive_state(clk_high.clone(), clk_low.clone(), cols.pc, is_real.clone());
        builder.send_state(
            clk_high.clone(),
            clk_low.clone() + clk_increment,
            next_pc,
            is_real.clone(),
        );

        builder.send_byte(
            AB::Expr::from_canonical_u32(ByteOpcode::Range as u32),
            (cols.clk_0_16 - AB::Expr::one()) * AB::F::from_canonical_u8(8).inverse(),
            AB::Expr::from_canonical_u32(13),
            AB::Expr::zero(),
            is_real.clone(),
        );

        builder.slice_range_check_u8(&[cols.clk_16_24.into(), AB::Expr::zero()], is_real.clone());
    }
}

#[derive(Clone, InputParams, InputExpr)]
pub struct CPUStateInput<AB: SP1AirBuilder> {
    pub cols: CPUState<AB::Var>,
    pub next_pc: [AB::Expr; 3],
    pub clk_increment: AB::Expr,
    pub is_real: AB::Expr,
}

impl<AB: SP1AirBuilder> SP1Operation<AB> for CPUState<AB::F> {
    type Input = CPUStateInput<AB>;
    type Output = ();

    fn lower(builder: &mut AB, input: Self::Input) -> Self::Output {
        Self::eval(builder, input.cols, input.next_pc, input.clk_increment, input.is_real);
    }
}