crc/
crc128.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
use crate::util::crc128;
use crc_catalog::Algorithm;

mod bytewise;
mod nolookup;
mod slice16;

const fn init(algorithm: &Algorithm<u128>, initial: u128) -> u128 {
    if algorithm.refin {
        initial.reverse_bits() >> (128u8 - algorithm.width)
    } else {
        initial << (128u8 - algorithm.width)
    }
}

const fn finalize(algorithm: &Algorithm<u128>, mut crc: u128) -> u128 {
    if algorithm.refin ^ algorithm.refout {
        crc = crc.reverse_bits();
    }
    if !algorithm.refout {
        crc >>= 128u8 - algorithm.width;
    }
    crc ^ algorithm.xorout
}

const fn update_nolookup(mut crc: u128, algorithm: &Algorithm<u128>, bytes: &[u8]) -> u128 {
    let poly = if algorithm.refin {
        let poly = algorithm.poly.reverse_bits();
        poly >> (128u8 - algorithm.width)
    } else {
        algorithm.poly << (128u8 - algorithm.width)
    };

    let mut i = 0;
    if algorithm.refin {
        while i < bytes.len() {
            let to_crc = (crc ^ bytes[i] as u128) & 0xFF;
            crc = crc128(poly, algorithm.refin, to_crc) ^ (crc >> 8);
            i += 1;
        }
    } else {
        while i < bytes.len() {
            let to_crc = ((crc >> 120) ^ bytes[i] as u128) & 0xFF;
            crc = crc128(poly, algorithm.refin, to_crc) ^ (crc << 8);
            i += 1;
        }
    }
    crc
}

const fn update_bytewise(mut crc: u128, reflect: bool, table: &[u128; 256], bytes: &[u8]) -> u128 {
    let mut i = 0;
    if reflect {
        while i < bytes.len() {
            let table_index = ((crc ^ bytes[i] as u128) & 0xFF) as usize;
            crc = table[table_index] ^ (crc >> 8);
            i += 1;
        }
    } else {
        while i < bytes.len() {
            let table_index = (((crc >> 120) ^ bytes[i] as u128) & 0xFF) as usize;
            crc = table[table_index] ^ (crc << 8);
            i += 1;
        }
    }
    crc
}

const fn update_slice16(
    mut crc: u128,
    reflect: bool,
    table: &[[u128; 256]; 16],
    bytes: &[u8],
) -> u128 {
    let mut i = 0;
    let len = bytes.len();
    if reflect {
        while i + 16 <= len {
            let current0 = bytes[i] ^ crc as u8;
            let current1 = bytes[i + 1] ^ (crc >> 8) as u8;
            let current2 = bytes[i + 2] ^ (crc >> 16) as u8;
            let current3 = bytes[i + 3] ^ (crc >> 24) as u8;
            let current4 = bytes[i + 4] ^ (crc >> 32) as u8;
            let current5 = bytes[i + 5] ^ (crc >> 40) as u8;
            let current6 = bytes[i + 6] ^ (crc >> 48) as u8;
            let current7 = bytes[i + 7] ^ (crc >> 56) as u8;
            let current8 = bytes[i + 8] ^ (crc >> 64) as u8;
            let current9 = bytes[i + 9] ^ (crc >> 72) as u8;
            let current10 = bytes[i + 10] ^ (crc >> 80) as u8;
            let current11 = bytes[i + 11] ^ (crc >> 88) as u8;
            let current12 = bytes[i + 12] ^ (crc >> 96) as u8;
            let current13 = bytes[i + 13] ^ (crc >> 104) as u8;
            let current14 = bytes[i + 14] ^ (crc >> 112) as u8;
            let current15 = bytes[i + 15] ^ (crc >> 120) as u8;

            crc = table[15][current0 as usize]
                ^ table[14][current1 as usize]
                ^ table[13][current2 as usize]
                ^ table[12][current3 as usize]
                ^ table[11][current4 as usize]
                ^ table[10][current5 as usize]
                ^ table[9][current6 as usize]
                ^ table[8][current7 as usize]
                ^ table[7][current8 as usize]
                ^ table[6][current9 as usize]
                ^ table[5][current10 as usize]
                ^ table[4][current11 as usize]
                ^ table[3][current12 as usize]
                ^ table[2][current13 as usize]
                ^ table[1][current14 as usize]
                ^ table[0][current15 as usize];

            i += 16;
        }

        while i < len {
            let table_index = ((crc ^ bytes[i] as u128) & 0xFF) as usize;
            crc = table[0][table_index] ^ (crc >> 8);
            i += 1;
        }
    } else {
        while i + 16 <= len {
            let current0 = bytes[i] ^ (crc >> 120) as u8;
            let current1 = bytes[i + 1] ^ (crc >> 112) as u8;
            let current2 = bytes[i + 2] ^ (crc >> 104) as u8;
            let current3 = bytes[i + 3] ^ (crc >> 96) as u8;
            let current4 = bytes[i + 4] ^ (crc >> 88) as u8;
            let current5 = bytes[i + 5] ^ (crc >> 80) as u8;
            let current6 = bytes[i + 6] ^ (crc >> 72) as u8;
            let current7 = bytes[i + 7] ^ (crc >> 64) as u8;
            let current8 = bytes[i + 8] ^ (crc >> 56) as u8;
            let current9 = bytes[i + 9] ^ (crc >> 48) as u8;
            let current10 = bytes[i + 10] ^ (crc >> 40) as u8;
            let current11 = bytes[i + 11] ^ (crc >> 32) as u8;
            let current12 = bytes[i + 12] ^ (crc >> 24) as u8;
            let current13 = bytes[i + 13] ^ (crc >> 16) as u8;
            let current14 = bytes[i + 14] ^ (crc >> 8) as u8;
            let current15 = bytes[i + 15] ^ crc as u8;

            crc = table[15][current0 as usize]
                ^ table[14][current1 as usize]
                ^ table[13][current2 as usize]
                ^ table[12][current3 as usize]
                ^ table[11][current4 as usize]
                ^ table[10][current5 as usize]
                ^ table[9][current6 as usize]
                ^ table[8][current7 as usize]
                ^ table[7][current8 as usize]
                ^ table[6][current9 as usize]
                ^ table[5][current10 as usize]
                ^ table[4][current11 as usize]
                ^ table[3][current12 as usize]
                ^ table[2][current13 as usize]
                ^ table[1][current14 as usize]
                ^ table[0][current15 as usize];

            i += 16;
        }

        while i < len {
            let table_index = (((crc >> 120) ^ bytes[i] as u128) & 0xFF) as usize;
            crc = table[0][table_index] ^ (crc << 8);
            i += 1;
        }
    }
    crc
}

#[cfg(test)]
mod test {
    use crate::*;
    use crc_catalog::{Algorithm, CRC_82_DARC};

    /// Test this optimized version against the well known implementation to ensure correctness
    #[test]
    fn correctness() {
        let data: &[&str] = &[
        "",
        "1",
        "1234",
        "123456789",
        "0123456789ABCDE",
        "01234567890ABCDEFGHIJK",
        "01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK01234567890ABCDEFGHIJK",
    ];

        pub const CRC_82_DARC_NONREFLEX: Algorithm<u128> = Algorithm {
            width: 82,
            poly: 0x0308c0111011401440411,
            init: 0x000000000000000000000,
            refin: false,
            refout: true,
            xorout: 0x000000000000000000000,
            check: 0x09ea83f625023801fd612,
            residue: 0x000000000000000000000,
        };

        let algs_to_test = [&CRC_82_DARC, &CRC_82_DARC_NONREFLEX];

        for alg in algs_to_test {
            for data in data {
                let crc_slice16 = Crc::<u128, Table<16>>::new(alg);
                let crc_nolookup = Crc::<u128, NoTable>::new(alg);
                let expected = Crc::<u128, Table<1>>::new(alg).checksum(data.as_bytes());

                // Check that doing all at once works as expected
                assert_eq!(crc_slice16.checksum(data.as_bytes()), expected);
                assert_eq!(crc_nolookup.checksum(data.as_bytes()), expected);

                let mut digest = crc_slice16.digest();
                digest.update(data.as_bytes());
                assert_eq!(digest.finalize(), expected);

                let mut digest = crc_nolookup.digest();
                digest.update(data.as_bytes());
                assert_eq!(digest.finalize(), expected);

                // Check that we didn't break updating from multiple sources
                if data.len() > 2 {
                    let data = data.as_bytes();
                    let data1 = &data[..data.len() / 2];
                    let data2 = &data[data.len() / 2..];
                    let mut digest = crc_slice16.digest();
                    digest.update(data1);
                    digest.update(data2);
                    assert_eq!(digest.finalize(), expected);
                    let mut digest = crc_nolookup.digest();
                    digest.update(data1);
                    digest.update(data2);
                    assert_eq!(digest.finalize(), expected);
                }
            }
        }
    }
}