-
Notifications
You must be signed in to change notification settings - Fork 61
/
crc.scala
308 lines (284 loc) · 10.2 KB
/
crc.scala
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
/*
* Copyright (c) 2013, Scodec
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package scodec.bits
/** Provides support for calculating cyclic redundancy checks.
*
* @see
* http://www.repairfaq.org/filipg/LINK/F_crc_v3.html
*/
object crc {
/** 32-bit CRC using poly 0x04c11db7, initial 0xffffffff, reflected input/output, and final xor
* 0xffffffff.
*/
lazy val crc32: BitVector => BitVector =
crc32Builder.updated(_).result
/** 32-bit CRC using poly 0x1edc6f41, initial 0xffffffff, reflected input/output, and final xor
* 0xffffffff.
*/
lazy val crc32c: BitVector => BitVector =
crc32cBuilder.updated(_).result
/** Builder for 32-bit CRC using poly 0x04c11db7, initial 0xffffffff, reflected input/output, and
* final xor 0xffffffff.
*/
lazy val crc32Builder: CrcBuilder[BitVector] =
builder32(0x04c11db7, 0xffffffff, true, true, 0xffffffff).mapResult(BitVector.fromInt(_))
/** Builder for 32-bit CRC using poly 0x1edc6f41, initial 0xffffffff, reflected input/output, and
* final xor 0xffffffff.
*/
lazy val crc32cBuilder: CrcBuilder[BitVector] =
builder32(0x1edc6f41, 0xffffffff, true, true, 0xffffffff).mapResult(BitVector.fromInt(_))
/** An immutable "builder" to incrementally compute a CRC.
*/
sealed trait CrcBuilder[R] {
def updated(data: BitVector): CrcBuilder[R]
def result: R
private[crc] def mapResult[S](f: R => S): CrcBuilder[S] = {
class Builder(inner: CrcBuilder[R]) extends CrcBuilder[S] {
def updated(data: BitVector): CrcBuilder[S] = new Builder(inner.updated(data))
def result: S = f(inner.result)
}
new Builder(this)
}
}
/** Constructs a table-based CRC function using the specified polynomial.
*
* Each of the input vectors must be the same size.
*
* @return
* function that calculates a `n`-bit CRC where `n = poly.size`
*/
def apply(
poly: BitVector,
initial: BitVector,
reflectInput: Boolean,
reflectOutput: Boolean,
finalXor: BitVector
): BitVector => BitVector = {
require(poly.nonEmpty, "empty polynomial")
require(
initial.size == poly.size && poly.size == finalXor.size,
"poly, initial, and finalXor must be same length"
)
if (poly.size == 32L)
int32(poly.toInt(), initial.toInt(), reflectInput, reflectOutput, finalXor.toInt()).andThen {
i => BitVector.fromInt(i)
}
else {
val b = builder(poly, initial, reflectInput, reflectOutput, finalXor)
b.updated(_).result
}
}
/** Constructs a table-based CRC builder using the specified polynomial. */
def builder(
poly: BitVector,
initial: BitVector,
reflectInput: Boolean,
reflectOutput: Boolean,
finalXor: BitVector
): CrcBuilder[BitVector] =
if (poly.size == 32L)
builder32(poly.toInt(), initial.toInt(), reflectInput, reflectOutput, finalXor.toInt())
.mapResult(BitVector.fromInt(_))
else builderGeneric(poly, initial, reflectInput, reflectOutput, finalXor)
private[bits] def builderGeneric(
poly: BitVector,
initial: BitVector,
reflectInput: Boolean,
reflectOutput: Boolean,
finalXor: BitVector
): CrcBuilder[BitVector] = {
val table = new Array[BitVector](256)
val zeroed = BitVector.fill(poly.size - 8)(false)
val m = 8L
@annotation.tailrec
def calculateTableIndex(idx: Int): Unit =
if (idx < table.size) {
@annotation.tailrec
def shift(k: Int, crcreg: BitVector): BitVector =
if (k < m)
shift(
k + 1, {
val shifted = crcreg << 1
if (crcreg.head) shifted.xor(poly) else shifted
}
)
else crcreg
table(idx) = shift(0, ByteVector(idx).bits ++ zeroed).compact
calculateTableIndex(idx + 1)
}
calculateTableIndex(0)
final class Builder(initial: BitVector) extends CrcBuilder[BitVector] {
def updated(input: BitVector): Builder =
if (poly.size < 8)
new Builder(
goBitwise(poly, if (reflectInput) input.reverseBitOrder else input, initial)
)
else {
var crcreg = initial
val size = input.size
val byteAligned = size % 8 == 0
val data = if (byteAligned) input.bytes else input.bytes.init
if (reflectInput)
data.foreach { inputByte =>
val index = crcreg.take(8) ^ BitVector(inputByte).reverse
val indexAsInt = index.bytes.head.toInt & 0x0ff
crcreg = (crcreg << 8) ^ table(indexAsInt)
}
else
data.foreach { inputByte =>
val index = crcreg.take(8) ^ BitVector(inputByte)
val indexAsInt = index.bytes.head.toInt & 0x0ff
crcreg = (crcreg << 8) ^ table(indexAsInt)
}
if (byteAligned)
new Builder(crcreg)
else {
val trailer = input.takeRight(size % 8)
new Builder(
goBitwise(poly, if (reflectInput) trailer.reverseBitOrder else trailer, crcreg)
)
}
}
def result: BitVector = (if (reflectOutput) initial.reverse else initial).xor(finalXor)
}
new Builder(initial)
}
private def goBitwise(poly: BitVector, remaining: BitVector, crcreg: BitVector): BitVector =
if (remaining.isEmpty) crcreg
else
goBitwise(
poly,
remaining.tail, {
val shifted = crcreg << 1
if (crcreg.head == remaining.head) shifted else shifted.xor(poly)
}
)
/** Constructs a 32-bit, table-based CRC function using the specified polynomial.
*
* @return
* function that calculates a 32-bit CRC
*/
def int32(
poly: Int,
initial: Int,
reflectInput: Boolean,
reflectOutput: Boolean,
finalXor: Int
): BitVector => Int = {
val b = builder32(poly, initial, reflectInput, reflectOutput, finalXor)
b.updated(_).result
}
/** Constructs a 32-bit, table-based CRC builder using the specified polynomial.
*/
def builder32(
poly: Int,
initial: Int,
reflectInput: Boolean,
reflectOutput: Boolean,
finalXor: Int
): CrcBuilder[Int] = {
val table = new Array[Int](256)
@annotation.tailrec
def calculateTableIndex(idx: Int): Unit =
if (idx < table.size) {
@annotation.tailrec
def shift(k: Int, crcreg: Int): Int =
if (k < 8)
shift(
k + 1, {
val shifted = crcreg << 1
if ((crcreg & 0x80000000) != 0) shifted ^ poly else shifted
}
)
else crcreg
table(idx) = shift(0, idx << 24)
calculateTableIndex(idx + 1)
}
calculateTableIndex(0)
final class Builder(initial: Int) extends CrcBuilder[Int] {
def updated(input: BitVector): Builder = {
var crcreg = initial
val size = input.size
val byteAligned = size % 8 == 0
val data = if (byteAligned) input.bytes else input.bytes.init
if (reflectInput)
data.foreach { inputByte =>
val index = (crcreg >>> 24) ^ (BitVector.reverseBitsInByte(inputByte) & 0xff)
crcreg = (crcreg << 8) ^ table(index)
}
else
data.foreach { inputByte =>
val index = (crcreg >>> 24) ^ (inputByte & 0xff)
crcreg = (crcreg << 8) ^ table(index)
}
if (byteAligned)
new Builder(crcreg)
else {
val trailer = input.takeRight(size % 8)
new Builder(
goBitwise(poly, if (reflectInput) trailer.reverseBitOrder else trailer, crcreg)
)
}
}
def result: Int =
(if (reflectOutput) BitVector.fromInt(initial).reverse.toInt() else initial) ^ finalXor
}
new Builder(initial)
}
private def goBitwise(poly: Int, remaining: BitVector, crcreg: Int): Int =
if (remaining.isEmpty) crcreg
else
goBitwise(
poly,
remaining.tail, {
val shifted = crcreg << 1
if (((crcreg & 0x80000000) != 0) == remaining.head) shifted else shifted ^ poly
}
)
/** Calculates a bitwise CRC of the specified value.
*
* If calculating a lot of CRCs, prefer the `apply` method, which precomputes a lookup table and
* uses it in each CRC calculation.
*
* @return
* function that calculates a `n`-bit CRC where `n = poly.size`
*/
def bitwise(
poly: BitVector,
initial: BitVector,
reflectInput: Boolean,
reflectOutput: Boolean,
finalXor: BitVector,
value: BitVector
): BitVector = {
val reg = goBitwise(poly, if (reflectInput) value.reverseBitOrder else value, initial)
(if (reflectOutput) reg.reverse else reg).xor(finalXor)
}
}