miden-crypto/src/hash/rescue/mds/freq.rs
src/hash/rescue/mds/freq.rsRaw
1// FFT-BASED MDS MULTIPLICATION HELPER FUNCTIONS
2// ================================================================================================
3
4/// This module contains helper functions as well as constants used to perform the vector-matrix
5/// multiplication step of the Rescue prime permutation. The special form of our MDS matrix
6/// i.e. being circular, allows us to reduce the vector-matrix multiplication to a Hadamard product
7/// of two vectors in "frequency domain". This follows from the simple fact that every circulant
8/// matrix has the columns of the discrete Fourier transform matrix as orthogonal eigenvectors.
9/// The implementation also avoids the use of 3-point FFTs, and 3-point iFFTs, and substitutes that
10/// with explicit expressions. It also avoids, due to the form of our matrix in the frequency domain,
11/// divisions by 2 and repeated modular reductions. This is because of our explicit choice of
12/// an MDS matrix that has small powers of 2 entries in frequency domain.
13/// The following implementation has benefited greatly from the discussions and insights of
14/// Hamish Ivey-Law and Jacqueline Nabaglo of Polygon Zero and is base on Nabaglo's Plonky2
15/// implementation.
16
17// Rescue MDS matrix in frequency domain.
18// More precisely, this is the output of the three 4-point (real) FFTs of the first column of
19// the MDS matrix i.e. just before the multiplication with the appropriate twiddle factors
20// and application of the final four 3-point FFT in order to get the full 12-point FFT.
21// The entries have been scaled appropriately in order to avoid divisions by 2 in iFFT2 and iFFT4.
22// The code to generate the matrix in frequency domain is based on an adaptation of a code, to generate
23// MDS matrices efficiently in original domain, that was developed by the Polygon Zero team.
24const MDS_FREQ_BLOCK_ONE: [i64; 3] = [16, 8, 16];
25const MDS_FREQ_BLOCK_TWO: [(i64, i64); 3] = [(-1, 2), (-1, 1), (4, 8)];
26const MDS_FREQ_BLOCK_THREE: [i64; 3] = [-8, 1, 1];
27
28// We use split 3 x 4 FFT transform in order to transform our vectors into the frequency domain.
29#[inline(always)]
30pub const fn mds_multiply_freq(state: [u64; 12]) -> [u64; 12] {
31 let [s0, s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11] = state;
32
33 let (u0, u1, u2) = fft4_real([s0, s3, s6, s9]);
34 let (u4, u5, u6) = fft4_real([s1, s4, s7, s10]);
35 let (u8, u9, u10) = fft4_real([s2, s5, s8, s11]);
36
37 // This where the multiplication in frequency domain is done. More precisely, and with
38 // the appropriate permutations in between, the sequence of
39 // 3-point FFTs --> multiplication by twiddle factors --> Hadamard multiplication -->
40 // 3 point iFFTs --> multiplication by (inverse) twiddle factors
41 // is "squashed" into one step composed of the functions "block1", "block2" and "block3".
42 // The expressions in the aforementioned functions are the result of explicit computations
43 // combined with the Karatsuba trick for the multiplication of Complex numbers.
44
45 let [v0, v4, v8] = block1([u0, u4, u8], MDS_FREQ_BLOCK_ONE);
46 let [v1, v5, v9] = block2([u1, u5, u9], MDS_FREQ_BLOCK_TWO);
47 let [v2, v6, v10] = block3([u2, u6, u10], MDS_FREQ_BLOCK_THREE);
48 // The 4th block is not computed as it is similar to the 2nd one, up to complex conjugation,
49 // and is, due to the use of the real FFT and iFFT, redundant.
50
51 let [s0, s3, s6, s9] = ifft4_real((v0, v1, v2));
52 let [s1, s4, s7, s10] = ifft4_real((v4, v5, v6));
53 let [s2, s5, s8, s11] = ifft4_real((v8, v9, v10));
54
55 [s0, s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11]
56}
57
58// We use the real FFT to avoid redundant computations. See https://www.mdpi.com/2076-3417/12/9/4700
59#[inline(always)]
60const fn fft2_real(x: [u64; 2]) -> [i64; 2] {
61 [(x[0] as i64 + x[1] as i64), (x[0] as i64 - x[1] as i64)]
62}
63
64#[inline(always)]
65const fn ifft2_real(y: [i64; 2]) -> [u64; 2] {
66 // We avoid divisions by 2 by appropriately scaling the MDS matrix constants.
67 [(y[0] + y[1]) as u64, (y[0] - y[1]) as u64]
68}
69
70#[inline(always)]
71const fn fft4_real(x: [u64; 4]) -> (i64, (i64, i64), i64) {
72 let [z0, z2] = fft2_real([x[0], x[2]]);
73 let [z1, z3] = fft2_real([x[1], x[3]]);
74 let y0 = z0 + z1;
75 let y1 = (z2, -z3);
76 let y2 = z0 - z1;
77 (y0, y1, y2)
78}
79
80#[inline(always)]
81const fn ifft4_real(y: (i64, (i64, i64), i64)) -> [u64; 4] {
82 // In calculating 'z0' and 'z1', division by 2 is avoided by appropriately scaling
83 // the MDS matrix constants.
84 let z0 = y.0 + y.2;
85 let z1 = y.0 - y.2;
86 let z2 = y.1 .0;
87 let z3 = -y.1 .1;
88
89 let [x0, x2] = ifft2_real([z0, z2]);
90 let [x1, x3] = ifft2_real([z1, z3]);
91
92 [x0, x1, x2, x3]
93}
94
95#[inline(always)]
96const fn block1(x: [i64; 3], y: [i64; 3]) -> [i64; 3] {
97 let [x0, x1, x2] = x;
98 let [y0, y1, y2] = y;
99 let z0 = x0 * y0 + x1 * y2 + x2 * y1;
100 let z1 = x0 * y1 + x1 * y0 + x2 * y2;
101 let z2 = x0 * y2 + x1 * y1 + x2 * y0;
102
103 [z0, z1, z2]
104}
105
106#[inline(always)]
107const fn block2(x: [(i64, i64); 3], y: [(i64, i64); 3]) -> [(i64, i64); 3] {
108 let [(x0r, x0i), (x1r, x1i), (x2r, x2i)] = x;
109 let [(y0r, y0i), (y1r, y1i), (y2r, y2i)] = y;
110 let x0s = x0r + x0i;
111 let x1s = x1r + x1i;
112 let x2s = x2r + x2i;
113 let y0s = y0r + y0i;
114 let y1s = y1r + y1i;
115 let y2s = y2r + y2i;
116
117 // Compute x0y0 − ix1y2 − ix2y1 using Karatsuba for complex numbers multiplication
118 let m0 = (x0r * y0r, x0i * y0i);
119 let m1 = (x1r * y2r, x1i * y2i);
120 let m2 = (x2r * y1r, x2i * y1i);
121 let z0r = (m0.0 - m0.1) + (x1s * y2s - m1.0 - m1.1) + (x2s * y1s - m2.0 - m2.1);
122 let z0i = (x0s * y0s - m0.0 - m0.1) + (-m1.0 + m1.1) + (-m2.0 + m2.1);
123 let z0 = (z0r, z0i);
124
125 // Compute x0y1 + x1y0 − ix2y2 using Karatsuba for complex numbers multiplication
126 let m0 = (x0r * y1r, x0i * y1i);
127 let m1 = (x1r * y0r, x1i * y0i);
128 let m2 = (x2r * y2r, x2i * y2i);
129 let z1r = (m0.0 - m0.1) + (m1.0 - m1.1) + (x2s * y2s - m2.0 - m2.1);
130 let z1i = (x0s * y1s - m0.0 - m0.1) + (x1s * y0s - m1.0 - m1.1) + (-m2.0 + m2.1);
131 let z1 = (z1r, z1i);
132
133 // Compute x0y2 + x1y1 + x2y0 using Karatsuba for complex numbers multiplication
134 let m0 = (x0r * y2r, x0i * y2i);
135 let m1 = (x1r * y1r, x1i * y1i);
136 let m2 = (x2r * y0r, x2i * y0i);
137 let z2r = (m0.0 - m0.1) + (m1.0 - m1.1) + (m2.0 - m2.1);
138 let z2i = (x0s * y2s - m0.0 - m0.1) + (x1s * y1s - m1.0 - m1.1) + (x2s * y0s - m2.0 - m2.1);
139 let z2 = (z2r, z2i);
140
141 [z0, z1, z2]
142}
143
144#[inline(always)]
145const fn block3(x: [i64; 3], y: [i64; 3]) -> [i64; 3] {
146 let [x0, x1, x2] = x;
147 let [y0, y1, y2] = y;
148 let z0 = x0 * y0 - x1 * y2 - x2 * y1;
149 let z1 = x0 * y1 + x1 * y0 - x2 * y2;
150 let z2 = x0 * y2 + x1 * y1 + x2 * y0;
151
152 [z0, z1, z2]
153}
154
155// TESTS
156// ================================================================================================
157
158#[cfg(test)]
159mod tests {
160 use super::super::{apply_mds, Felt, MDS, ZERO};
161 use proptest::prelude::*;
162
163 const STATE_WIDTH: usize = 12;
164
165 #[inline(always)]
166 fn apply_mds_naive(state: &mut [Felt; STATE_WIDTH]) {
167 let mut result = [ZERO; STATE_WIDTH];
168 result.iter_mut().zip(MDS).for_each(|(r, mds_row)| {
169 state.iter().zip(mds_row).for_each(|(&s, m)| {
170 *r += m * s;
171 });
172 });
173 *state = result;
174 }
175
176 proptest! {
177 #[test]
178 fn mds_freq_proptest(a in any::<[u64; STATE_WIDTH]>()) {
179
180 let mut v1 = [ZERO; STATE_WIDTH];
181 let mut v2;
182
183 for i in 0..STATE_WIDTH {
184 v1[i] = Felt::new(a[i]);
185 }
186 v2 = v1;
187
188 apply_mds_naive(&mut v1);
189 apply_mds(&mut v2);
190
191 prop_assert_eq!(v1, v2);
192 }
193 }
194}