sp1_recursion_core/air/
memory.rs

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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
use p3_field::PrimeField32;
use sp1_derive::AlignedBorrow;

use crate::air::Block;

#[derive(AlignedBorrow, Default, Debug, Clone)]
#[repr(C)]
pub struct MemoryInitCols<T> {
    pub addr: T,
    pub timestamp: T,
    pub value: Block<T>,
    pub is_initialize: T,
    pub is_finalize: T,

    /// This column is the least significant 16 bit limb of next_address - current_address.
    pub diff_16bit_limb: T,

    /// This column is the most significant 8 bit limb of next_address - current_address.
    pub diff_12bit_limb: T,

    /// Same for the address column.
    pub addr_16bit_limb: T,
    pub addr_12bit_limb: T,

    // An additional column to indicate if the memory row is a padded row.
    pub is_real: T,

    // A flag column for when range checks need to be applied to the diff columns. Range checks
    // always need to be applied to the address columns.
    pub is_range_check: T,
}

impl<T: PrimeField32> MemoryInitCols<T> {
    pub fn new() -> Self {
        Self {
            addr: T::zero(),
            timestamp: T::zero(),
            value: Block::from([T::zero(); 4]),
            is_initialize: T::zero(),
            is_finalize: T::zero(),
            diff_16bit_limb: T::zero(),
            diff_12bit_limb: T::zero(),
            addr_16bit_limb: T::zero(),
            addr_12bit_limb: T::zero(),
            is_real: T::zero(),
            is_range_check: T::zero(),
        }
    }
}

/// NOTE: These are very similar to core/src/memory/columns.rs
/// The reason we cannot use those structs directly is that they use "shard".
/// In our recursive VM, we don't have shards, we only have `clk` (i.e. timestamp).

/// Memory read access.
#[derive(AlignedBorrow, Default, Debug, Clone, Copy)]
#[repr(C)]
pub struct MemoryReadCols<T> {
    pub access: MemoryAccessCols<T, Block<T>>,
}

/// Memory read-write access.
#[derive(AlignedBorrow, Default, Debug, Clone, Copy)]
#[repr(C)]
pub struct MemoryReadWriteCols<T> {
    pub prev_value: Block<T>,
    pub access: MemoryAccessCols<T, Block<T>>,
}

/// Memory read access of a single field element.
#[derive(AlignedBorrow, Default, Debug, Clone, Copy)]
#[repr(C)]
pub struct MemoryReadSingleCols<T> {
    pub access: MemoryAccessCols<T, T>,
}

/// Memory read-write access of a single field element.
#[derive(AlignedBorrow, Default, Debug, Clone, Copy)]
#[repr(C)]
pub struct MemoryReadWriteSingleCols<T> {
    pub prev_value: T,
    pub access: MemoryAccessCols<T, T>,
}

#[derive(AlignedBorrow, Default, Debug, Clone, Copy)]
#[repr(C)]
pub struct MemoryAccessCols<T, TValue> {
    /// The value of the memory access.
    pub value: TValue,

    /// The previous timestamp that this memory access is being read from.
    pub prev_timestamp: T,

    /// The following columns are decomposed limbs for the difference between the current access's
    /// timestamp and the previous access's timestamp.  Note the actual value of the timestamp
    /// is either the accesses' shard or clk depending on the value of compare_clk.

    /// This column is the least significant 16 bit limb of current access timestamp - prev access
    /// timestamp.
    pub diff_16bit_limb: T,

    /// This column is the most significant 12 bit limb of current access timestamp - prev access
    /// timestamp.
    pub diff_12bit_limb: T,
}

/// The common columns for all memory access types.
pub trait MemoryCols<T, TValue> {
    fn access(&self) -> &MemoryAccessCols<T, TValue>;

    fn access_mut(&mut self) -> &mut MemoryAccessCols<T, TValue>;

    fn prev_value(&self) -> &TValue;

    fn prev_value_mut(&mut self) -> &mut TValue;

    fn value(&self) -> &TValue;

    fn value_mut(&mut self) -> &mut TValue;
}

pub trait MemoryAccessTimestampCols<T> {
    fn prev_timestamp(&self) -> &T;

    fn diff_16bit_limb(&self) -> &T;

    fn diff_12bit_limb(&self) -> &T;
}

impl<T> MemoryAccessTimestampCols<T> for MemoryAccessCols<T, Block<T>> {
    fn prev_timestamp(&self) -> &T {
        &self.prev_timestamp
    }

    fn diff_16bit_limb(&self) -> &T {
        &self.diff_16bit_limb
    }

    fn diff_12bit_limb(&self) -> &T {
        &self.diff_12bit_limb
    }
}

impl<T> MemoryAccessTimestampCols<T> for MemoryAccessCols<T, T> {
    fn prev_timestamp(&self) -> &T {
        &self.prev_timestamp
    }

    fn diff_16bit_limb(&self) -> &T {
        &self.diff_16bit_limb
    }

    fn diff_12bit_limb(&self) -> &T {
        &self.diff_12bit_limb
    }
}

impl<T> MemoryCols<T, Block<T>> for MemoryReadCols<T> {
    fn access(&self) -> &MemoryAccessCols<T, Block<T>> {
        &self.access
    }

    fn access_mut(&mut self) -> &mut MemoryAccessCols<T, Block<T>> {
        &mut self.access
    }

    fn prev_value(&self) -> &Block<T> {
        &self.access.value
    }

    fn prev_value_mut(&mut self) -> &mut Block<T> {
        &mut self.access.value
    }

    fn value(&self) -> &Block<T> {
        &self.access.value
    }

    fn value_mut(&mut self) -> &mut Block<T> {
        &mut self.access.value
    }
}

impl<T> MemoryCols<T, Block<T>> for MemoryReadWriteCols<T> {
    fn access(&self) -> &MemoryAccessCols<T, Block<T>> {
        &self.access
    }

    fn access_mut(&mut self) -> &mut MemoryAccessCols<T, Block<T>> {
        &mut self.access
    }

    fn prev_value(&self) -> &Block<T> {
        &self.prev_value
    }

    fn prev_value_mut(&mut self) -> &mut Block<T> {
        &mut self.prev_value
    }

    fn value(&self) -> &Block<T> {
        &self.access.value
    }

    fn value_mut(&mut self) -> &mut Block<T> {
        &mut self.access.value
    }
}

impl<T> MemoryCols<T, T> for MemoryReadSingleCols<T> {
    fn access(&self) -> &MemoryAccessCols<T, T> {
        &self.access
    }

    fn access_mut(&mut self) -> &mut MemoryAccessCols<T, T> {
        &mut self.access
    }

    fn prev_value(&self) -> &T {
        &self.access.value
    }

    fn prev_value_mut(&mut self) -> &mut T {
        &mut self.access.value
    }

    fn value(&self) -> &T {
        &self.access.value
    }

    fn value_mut(&mut self) -> &mut T {
        &mut self.access.value
    }
}

impl<T> MemoryCols<T, T> for MemoryReadWriteSingleCols<T> {
    fn access(&self) -> &MemoryAccessCols<T, T> {
        &self.access
    }

    fn access_mut(&mut self) -> &mut MemoryAccessCols<T, T> {
        &mut self.access
    }

    fn prev_value(&self) -> &T {
        &self.prev_value
    }

    fn prev_value_mut(&mut self) -> &mut T {
        &mut self.prev_value
    }

    fn value(&self) -> &T {
        &self.access.value
    }

    fn value_mut(&mut self) -> &mut T {
        &mut self.access.value
    }
}