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
261
262
263
//! The `BinaryExtensionTableSM` module implements the logic for managing the Binary Extension
//! Table.
//!
//! This state machine is responsible for calculating extension binary table rows.
use zisk_core::{zisk_ops::ZiskOp, P2_11, P2_17, P2_8};
/// Represents operations supported by the Binary Extension Table.
#[derive(Debug, Clone, PartialEq, Copy)]
#[repr(u8)]
pub enum BinaryExtensionTableOp {
Sll = ZiskOp::SLL,
Srl = ZiskOp::SRL,
Sra = ZiskOp::SRA,
SllW = ZiskOp::SLL_W,
SrlW = ZiskOp::SRL_W,
SraW = ZiskOp::SRA_W,
SextB = ZiskOp::SIGNEXTEND_B,
SextH = ZiskOp::SIGNEXTEND_H,
SextW = ZiskOp::SIGNEXTEND_W,
Rev8 = ZiskOp::REV8,
OrcB = ZiskOp::ORC_B,
Rol = ZiskOp::ROL,
RolW = ZiskOp::ROL_W,
Ror = ZiskOp::ROR,
RorW = ZiskOp::ROR_W,
Cpop = ZiskOp::CPOP,
CpopW = ZiskOp::CPOP_W,
Ctz = ZiskOp::CTZ,
CtzW = ZiskOp::CTZ_W,
Clz = ZiskOp::CLZ,
ClzW = ZiskOp::CLZ_W,
Pack = ZiskOp::PACK,
PackH = ZiskOp::PACK_H,
PackW = ZiskOp::PACK_W,
Bclr = ZiskOp::BCLR,
Bext = ZiskOp::BEXT,
Binv = ZiskOp::BINV,
Bset = ZiskOp::BSET,
SllUw = ZiskOp::SLL_U_W,
}
/// The `BinaryExtensionTableSM` struct encapsulates the Binary Extension Table's logic.
pub struct BinaryExtensionTableSM;
impl BinaryExtensionTableSM {
pub const TABLE_ID: usize = 124;
/// Rows the table has, i.e. `BINARY_EXTENSION_TABLE_SIZE` in `binary_extension_table.pil`.
///
/// The witness needs it to size the histogram it tallies the multiplicities into, so it cannot
/// live in the tests alone. `tests::table_regions_tile_the_whole_table` is what keeps it in step
/// with the PIL: the per-opcode regions must add up to exactly this.
pub const TABLE_ROWS: u64 = 2_510_848;
/// Calculates the row index in the Binary Extension Table based on the operation and its
/// inputs.
///
/// # Arguments
/// * `opcode` - The operation code, as a `BinaryExtensionTableOp`.
/// * `offset` - The offset value.
/// * `a` - The first operand.
/// * `b` - The second operand.
///
/// # Returns
/// A `u64` representing the calculated row index in the table.
///
/// # Panics
/// In debug mode, it panics if `offset` > 0x07, `a` > 0xFF, or `b` > 0x3F, as these violate
/// table constraints. Only the low 6 bits of B are relevant (the shift amount is masked with
/// LS_6_BITS / LS_5_BITS), so B is enumerated over 0..63 and each B-using block is 2^17 rows.
pub fn calculate_table_row(opcode: BinaryExtensionTableOp, offset: u64, a: u64, b: u64) -> u64 {
//lookup_proves(BINARY_EXTENSION_TABLE_ID, [OP, OFFSET, A, B, C0, C1], multiplicity);
debug_assert!(offset <= 0x07);
debug_assert!(a <= 0xFF);
debug_assert!(b <= 0x3F);
// Calculate the different row offset contributors, according to the PIL
let offset_a: u64 = a;
let offset_offset: u64 = offset * P2_8;
let offset_b: u64 = b * P2_11;
let offset_opcode: u64 = Self::offset_opcode(opcode);
offset_a + offset_offset + offset_b + offset_opcode
}
/// Computes the opcode offset for a given `BinaryExtensionTableOp`.
///
/// # Arguments
/// * `opcode` - The operation code as a `BinaryExtensionTableOp`.
///
/// # Returns
/// A `u64` representing the offset contribution of the opcode.
fn offset_opcode(opcode: BinaryExtensionTableOp) -> u64 {
// Every B-using block (shift / rotate / single-bit families) is 2^17 rows (2^8 A *
// 2^3 offset * 2^6 B); the single-input blocks (sext / rev8 / orcb / cpop / pack) are
// 2^11 rows; the byte-chain blocks (ctz / clz) are 2^17 rows (2^6 acc_in * 2^3 offset *
// 2^8 A). Offsets accumulate in the same order the OP column is laid out in the PIL.
match opcode {
BinaryExtensionTableOp::Sll => 0,
BinaryExtensionTableOp::Srl => P2_17,
BinaryExtensionTableOp::Sra => 2 * P2_17,
BinaryExtensionTableOp::SllW => 3 * P2_17,
BinaryExtensionTableOp::SrlW => 4 * P2_17,
BinaryExtensionTableOp::SraW => 5 * P2_17,
BinaryExtensionTableOp::SextB => 6 * P2_17,
BinaryExtensionTableOp::SextH => 6 * P2_17 + P2_11,
BinaryExtensionTableOp::SextW => 6 * P2_17 + 2 * P2_11,
BinaryExtensionTableOp::Rev8 => 6 * P2_17 + 3 * P2_11,
BinaryExtensionTableOp::OrcB => 6 * P2_17 + 4 * P2_11,
BinaryExtensionTableOp::Rol => 6 * P2_17 + 5 * P2_11,
BinaryExtensionTableOp::RolW => 7 * P2_17 + 5 * P2_11,
BinaryExtensionTableOp::Ror => 8 * P2_17 + 5 * P2_11,
BinaryExtensionTableOp::RorW => 9 * P2_17 + 5 * P2_11,
BinaryExtensionTableOp::Cpop => 10 * P2_17 + 5 * P2_11,
BinaryExtensionTableOp::CpopW => 10 * P2_17 + 6 * P2_11,
// Chain ops: the fourth `calculate_table_row` argument carries acc_in (not B),
// contributing acc_in * P2_11 as the outer dimension within the block.
BinaryExtensionTableOp::Ctz => 10 * P2_17 + 7 * P2_11,
BinaryExtensionTableOp::CtzW => 11 * P2_17 + 7 * P2_11,
BinaryExtensionTableOp::Clz => 12 * P2_17 + 7 * P2_11,
BinaryExtensionTableOp::ClzW => 13 * P2_17 + 7 * P2_11,
// Pack ops are single-block (B unused), placed after the four chain blocks.
BinaryExtensionTableOp::Pack => 14 * P2_17 + 7 * P2_11,
BinaryExtensionTableOp::PackH => 14 * P2_17 + 8 * P2_11,
BinaryExtensionTableOp::PackW => 14 * P2_17 + 9 * P2_11,
// Single-bit ops are shift-family (6-bit B range), placed after the pack blocks.
BinaryExtensionTableOp::Bclr => 14 * P2_17 + 10 * P2_11,
BinaryExtensionTableOp::Bext => 15 * P2_17 + 10 * P2_11,
BinaryExtensionTableOp::Binv => 16 * P2_17 + 10 * P2_11,
BinaryExtensionTableOp::Bset => 17 * P2_17 + 10 * P2_11,
// slli.uw is shift-family too (6-bit B range), placed after the single-bit blocks.
BinaryExtensionTableOp::SllUw => 18 * P2_17 + 10 * P2_11,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
/// Size in rows of each region, in the same order as the `OP` fixed column of
/// `binary_extension_table.pil`. MUST be kept in sync with it.
const TABLE_LAYOUT: &[(BinaryExtensionTableOp, u64)] = &[
(BinaryExtensionTableOp::Sll, P2_17),
(BinaryExtensionTableOp::Srl, P2_17),
(BinaryExtensionTableOp::Sra, P2_17),
(BinaryExtensionTableOp::SllW, P2_17),
(BinaryExtensionTableOp::SrlW, P2_17),
(BinaryExtensionTableOp::SraW, P2_17),
(BinaryExtensionTableOp::SextB, P2_11),
(BinaryExtensionTableOp::SextH, P2_11),
(BinaryExtensionTableOp::SextW, P2_11),
(BinaryExtensionTableOp::Rev8, P2_11),
(BinaryExtensionTableOp::OrcB, P2_11),
(BinaryExtensionTableOp::Rol, P2_17),
(BinaryExtensionTableOp::RolW, P2_17),
(BinaryExtensionTableOp::Ror, P2_17),
(BinaryExtensionTableOp::RorW, P2_17),
(BinaryExtensionTableOp::Cpop, P2_11),
(BinaryExtensionTableOp::CpopW, P2_11),
(BinaryExtensionTableOp::Ctz, P2_17),
(BinaryExtensionTableOp::CtzW, P2_17),
(BinaryExtensionTableOp::Clz, P2_17),
(BinaryExtensionTableOp::ClzW, P2_17),
(BinaryExtensionTableOp::Pack, P2_11),
(BinaryExtensionTableOp::PackH, P2_11),
(BinaryExtensionTableOp::PackW, P2_11),
(BinaryExtensionTableOp::Bclr, P2_17),
(BinaryExtensionTableOp::Bext, P2_17),
(BinaryExtensionTableOp::Binv, P2_17),
(BinaryExtensionTableOp::Bset, P2_17),
(BinaryExtensionTableOp::SllUw, P2_17),
];
/// MUST match `BINARY_EXTENSION_TABLE_SIZE` in `binary_extension_table.pil`.
const BINARY_EXTENSION_TABLE_SIZE: u64 = BinaryExtensionTableSM::TABLE_ROWS;
#[test]
fn table_regions_tile_the_whole_table() {
let mut offset = 0;
for (op, size) in TABLE_LAYOUT {
assert_eq!(
BinaryExtensionTableSM::offset_opcode(*op),
offset,
"unexpected region offset for {op:?}"
);
offset += size;
}
assert_eq!(
offset, BINARY_EXTENSION_TABLE_SIZE,
"the regions do not tile BINARY_EXTENSION_TABLE_SIZE"
);
}
#[test]
fn sll_uw_rows_stay_inside_their_region() {
let base = BinaryExtensionTableSM::offset_opcode(BinaryExtensionTableOp::SllUw);
for b in [0, 1, 31, 63] {
for offset in 0..8 {
for a in [0, 1, 0xFF] {
let row = BinaryExtensionTableSM::calculate_table_row(
BinaryExtensionTableOp::SllUw,
offset,
a,
b,
);
// Same decomposition as the fixed columns of binary_extension_table.pil
assert_eq!(row, base + a + offset * P2_8 + b * P2_11);
assert!(row >= base && row < base + P2_17);
}
}
}
}
/// Mirror of the `OP_SLL_U_W` case of `binary_extension_table.pil`, for a single byte.
fn sll_uw_table_row(offset: u32, a: u64, b: u64) -> u64 {
if offset >= 4 {
return 0;
}
// The 64-bit result drops whatever crosses bit 63 (the PIL masks it with MASK_64)
let bits_to_shift = (b & 0x3F) + 8 * offset as u64;
if bits_to_shift < 64 {
a << bits_to_shift
} else {
0
}
}
#[test]
fn sll_uw_byte_chain_matches_the_zisk_op() {
let values = [
0u64,
1,
0xFF,
0x8000_0000,
0xFFFF_FFFF,
0x1234_5678_9ABC_DEF0,
u64::MAX,
0x0102_0408_1020_4080,
];
for a in values {
for b in 0..64u64 {
// The instruction sets m32, so the bus (and hence the witness) only ever carries
// the low half of a: that masking is the zero extension the operation needs.
let bus_a = a & 0xFFFF_FFFF;
let (expected, flag) = ZiskOp::execute(ZiskOp::SLL_U_W, bus_a, b);
assert!(!flag);
let a_bytes = bus_a.to_le_bytes();
let mut out: u64 = 0;
for (offset, byte) in a_bytes.iter().enumerate() {
out += sll_uw_table_row(offset as u32, *byte as u64, b);
}
assert_eq!(out, expected, "mismatch for a={bus_a:#x} b={b}");
}
}
}
}