openvm_sha256_circuit/sha256_chip/
columns.rs

Help
1//! WARNING: the order of fields in the structs is important, do not change it
2
3use openvm_circuit::{
4    arch::ExecutionState,
5    system::memory::offline_checker::{MemoryReadAuxCols, MemoryWriteAuxCols},
6};
7use openvm_circuit_primitives::AlignedBorrow;
8use openvm_instructions::riscv::RV32_REGISTER_NUM_LIMBS;
9use openvm_sha256_air::{Sha256DigestCols, Sha256RoundCols};
10
11use super::{SHA256_REGISTER_READS, SHA256_WRITE_SIZE};
12
13/// the first 16 rows of every SHA256 block will be of type Sha256VmRoundCols and the last row will be of type Sha256VmDigestCols
14#[repr(C)]
15#[derive(Clone, Copy, Debug, AlignedBorrow)]
16pub struct Sha256VmRoundCols<T> {
17    pub control: Sha256VmControlCols<T>,
18    pub inner: Sha256RoundCols<T>,
19    pub read_aux: MemoryReadAuxCols<T>,
20}
21
22#[repr(C)]
23#[derive(Clone, Copy, Debug, AlignedBorrow)]
24pub struct Sha256VmDigestCols<T> {
25    pub control: Sha256VmControlCols<T>,
26    pub inner: Sha256DigestCols<T>,
27
28    pub from_state: ExecutionState<T>,
29    /// It is counter intuitive, but we will constrain the register reads on the very last row of every message
30    pub rd_ptr: T,
31    pub rs1_ptr: T,
32    pub rs2_ptr: T,
33    pub dst_ptr: [T; RV32_REGISTER_NUM_LIMBS],
34    pub src_ptr: [T; RV32_REGISTER_NUM_LIMBS],
35    pub len_data: [T; RV32_REGISTER_NUM_LIMBS],
36    pub register_reads_aux: [MemoryReadAuxCols<T>; SHA256_REGISTER_READS],
37    pub writes_aux: MemoryWriteAuxCols<T, SHA256_WRITE_SIZE>,
38}
39
40/// These are the columns that are used on both round and digest rows
41#[repr(C)]
42#[derive(Clone, Copy, Debug, AlignedBorrow)]
43pub struct Sha256VmControlCols<T> {
44    /// Note: We will use the buffer in `inner.message_schedule` as the message data
45    /// This is the length of the entire message in bytes
46    pub len: T,
47    /// Need to keep timestamp and read_ptr since block reads don't have the necessary information
48    pub cur_timestamp: T,
49    pub read_ptr: T,
50    /// Padding flags which will be used to encode the the number of non-padding cells in the current row
51    pub pad_flags: [T; 6],
52    /// A boolean flag that indicates whether a padding already occurred
53    pub padding_occurred: T,
54}
55
56/// Width of the Sha256VmControlCols
57pub const SHA256VM_CONTROL_WIDTH: usize = Sha256VmControlCols::<u8>::width();
58/// Width of the Sha256VmRoundCols
59pub const SHA256VM_ROUND_WIDTH: usize = Sha256VmRoundCols::<u8>::width();
60/// Width of the Sha256VmDigestCols
61pub const SHA256VM_DIGEST_WIDTH: usize = Sha256VmDigestCols::<u8>::width();
62/// Width of the Sha256Cols
63pub const SHA256VM_WIDTH: usize = if SHA256VM_ROUND_WIDTH > SHA256VM_DIGEST_WIDTH {
64    SHA256VM_ROUND_WIDTH
65} else {
66    SHA256VM_DIGEST_WIDTH
67};
openvm_sha256_circuit/sha256_chip/columns.rs

openvm_sha256_circuit/sha256_chip/
columns.rs
