|
3 | 3 | import java.util.zip.Checksum; |
4 | 4 |
|
5 | 5 | /** |
6 | | - * This class generates a CRC32C checksum, defined by rfc3720 section B.4. |
7 | | - * The native implementation is not available in Java versions older than Java 9 |
8 | | - * The implementation is ported from Google's cloud package, copyrighted 2011. |
9 | | - * Works well for Intel and ARM chips independently of Java version. |
| 6 | + * CRC32C checksum implementation with automatic hardware acceleration. |
| 7 | + * <p> |
| 8 | + * This class generates a CRC32C checksum as defined by RFC 3720 Section B.4. |
| 9 | + * It automatically detects and uses the JDK's hardware-accelerated implementation |
| 10 | + * (available in Java 9+) when present, falling back to a portable software |
| 11 | + * implementation otherwise. |
| 12 | + * <p> |
| 13 | + * The hardware-accelerated path uses CPU intrinsics (SSE4.2 on x86, CRC extensions |
| 14 | + * on ARM) and can be 30-40x faster than the software implementation for large data. |
| 15 | + * <p> |
| 16 | + * The software fallback is ported from Google's cloud package (2011) and works |
| 17 | + * correctly on all platforms regardless of Java version. |
10 | 18 | */ |
11 | 19 | public final class CRC32C implements Checksum { |
12 | 20 |
|
13 | | - private static final long[] CRC_TABLE = { |
14 | | - 0x00000000, 0xf26b8303, 0xe13b70f7, 0x1350f3f4, |
15 | | - 0xc79a971f, 0x35f1141c, 0x26a1e7e8, 0xd4ca64eb, |
16 | | - 0x8ad958cf, 0x78b2dbcc, 0x6be22838, 0x9989ab3b, |
17 | | - 0x4d43cfd0, 0xbf284cd3, 0xac78bf27, 0x5e133c24, |
18 | | - 0x105ec76f, 0xe235446c, 0xf165b798, 0x030e349b, |
19 | | - 0xd7c45070, 0x25afd373, 0x36ff2087, 0xc494a384, |
20 | | - 0x9a879fa0, 0x68ec1ca3, 0x7bbcef57, 0x89d76c54, |
21 | | - 0x5d1d08bf, 0xaf768bbc, 0xbc267848, 0x4e4dfb4b, |
22 | | - 0x20bd8ede, 0xd2d60ddd, 0xc186fe29, 0x33ed7d2a, |
23 | | - 0xe72719c1, 0x154c9ac2, 0x061c6936, 0xf477ea35, |
24 | | - 0xaa64d611, 0x580f5512, 0x4b5fa6e6, 0xb93425e5, |
25 | | - 0x6dfe410e, 0x9f95c20d, 0x8cc531f9, 0x7eaeb2fa, |
26 | | - 0x30e349b1, 0xc288cab2, 0xd1d83946, 0x23b3ba45, |
27 | | - 0xf779deae, 0x05125dad, 0x1642ae59, 0xe4292d5a, |
28 | | - 0xba3a117e, 0x4851927d, 0x5b016189, 0xa96ae28a, |
29 | | - 0x7da08661, 0x8fcb0562, 0x9c9bf696, 0x6ef07595, |
30 | | - 0x417b1dbc, 0xb3109ebf, 0xa0406d4b, 0x522bee48, |
31 | | - 0x86e18aa3, 0x748a09a0, 0x67dafa54, 0x95b17957, |
32 | | - 0xcba24573, 0x39c9c670, 0x2a993584, 0xd8f2b687, |
33 | | - 0x0c38d26c, 0xfe53516f, 0xed03a29b, 0x1f682198, |
34 | | - 0x5125dad3, 0xa34e59d0, 0xb01eaa24, 0x42752927, |
35 | | - 0x96bf4dcc, 0x64d4cecf, 0x77843d3b, 0x85efbe38, |
36 | | - 0xdbfc821c, 0x2997011f, 0x3ac7f2eb, 0xc8ac71e8, |
37 | | - 0x1c661503, 0xee0d9600, 0xfd5d65f4, 0x0f36e6f7, |
38 | | - 0x61c69362, 0x93ad1061, 0x80fde395, 0x72966096, |
39 | | - 0xa65c047d, 0x5437877e, 0x4767748a, 0xb50cf789, |
40 | | - 0xeb1fcbad, 0x197448ae, 0x0a24bb5a, 0xf84f3859, |
41 | | - 0x2c855cb2, 0xdeeedfb1, 0xcdbe2c45, 0x3fd5af46, |
42 | | - 0x7198540d, 0x83f3d70e, 0x90a324fa, 0x62c8a7f9, |
43 | | - 0xb602c312, 0x44694011, 0x5739b3e5, 0xa55230e6, |
44 | | - 0xfb410cc2, 0x092a8fc1, 0x1a7a7c35, 0xe811ff36, |
45 | | - 0x3cdb9bdd, 0xceb018de, 0xdde0eb2a, 0x2f8b6829, |
46 | | - 0x82f63b78, 0x709db87b, 0x63cd4b8f, 0x91a6c88c, |
47 | | - 0x456cac67, 0xb7072f64, 0xa457dc90, 0x563c5f93, |
48 | | - 0x082f63b7, 0xfa44e0b4, 0xe9141340, 0x1b7f9043, |
49 | | - 0xcfb5f4a8, 0x3dde77ab, 0x2e8e845f, 0xdce5075c, |
50 | | - 0x92a8fc17, 0x60c37f14, 0x73938ce0, 0x81f80fe3, |
51 | | - 0x55326b08, 0xa759e80b, 0xb4091bff, 0x466298fc, |
52 | | - 0x1871a4d8, 0xea1a27db, 0xf94ad42f, 0x0b21572c, |
53 | | - 0xdfeb33c7, 0x2d80b0c4, 0x3ed04330, 0xccbbc033, |
54 | | - 0xa24bb5a6, 0x502036a5, 0x4370c551, 0xb11b4652, |
55 | | - 0x65d122b9, 0x97baa1ba, 0x84ea524e, 0x7681d14d, |
56 | | - 0x2892ed69, 0xdaf96e6a, 0xc9a99d9e, 0x3bc21e9d, |
57 | | - 0xef087a76, 0x1d63f975, 0x0e330a81, 0xfc588982, |
58 | | - 0xb21572c9, 0x407ef1ca, 0x532e023e, 0xa145813d, |
59 | | - 0x758fe5d6, 0x87e466d5, 0x94b49521, 0x66df1622, |
60 | | - 0x38cc2a06, 0xcaa7a905, 0xd9f75af1, 0x2b9cd9f2, |
61 | | - 0xff56bd19, 0x0d3d3e1a, 0x1e6dcdee, 0xec064eed, |
62 | | - 0xc38d26c4, 0x31e6a5c7, 0x22b65633, 0xd0ddd530, |
63 | | - 0x0417b1db, 0xf67c32d8, 0xe52cc12c, 0x1747422f, |
64 | | - 0x49547e0b, 0xbb3ffd08, 0xa86f0efc, 0x5a048dff, |
65 | | - 0x8ecee914, 0x7ca56a17, 0x6ff599e3, 0x9d9e1ae0, |
66 | | - 0xd3d3e1ab, 0x21b862a8, 0x32e8915c, 0xc083125f, |
67 | | - 0x144976b4, 0xe622f5b7, 0xf5720643, 0x07198540, |
68 | | - 0x590ab964, 0xab613a67, 0xb831c993, 0x4a5a4a90, |
69 | | - 0x9e902e7b, 0x6cfbad78, 0x7fab5e8c, 0x8dc0dd8f, |
70 | | - 0xe330a81a, 0x115b2b19, 0x020bd8ed, 0xf0605bee, |
71 | | - 0x24aa3f05, 0xd6c1bc06, 0xc5914ff2, 0x37faccf1, |
72 | | - 0x69e9f0d5, 0x9b8273d6, 0x88d28022, 0x7ab90321, |
73 | | - 0xae7367ca, 0x5c18e4c9, 0x4f48173d, 0xbd23943e, |
74 | | - 0xf36e6f75, 0x0105ec76, 0x12551f82, 0xe03e9c81, |
75 | | - 0x34f4f86a, 0xc69f7b69, 0xd5cf889d, 0x27a40b9e, |
76 | | - 0x79b737ba, 0x8bdcb4b9, 0x988c474d, 0x6ae7c44e, |
77 | | - 0xbe2da0a5, 0x4c4623a6, 0x5f16d052, 0xad7d5351 |
78 | | - }; |
| 21 | + /** |
| 22 | + * Indicates whether the JDK's hardware-accelerated CRC32C is available. |
| 23 | + */ |
| 24 | + private static final boolean JDK_CRC32C_AVAILABLE; |
79 | 25 |
|
80 | | - private static final long LONG_MASK = 0xffffffffL; |
81 | | - private static final long BYTE_MASK = 0xff; |
| 26 | + /** |
| 27 | + * The JDK CRC32C class, if available (null otherwise). |
| 28 | + */ |
| 29 | + private static final Class<?> JDK_CRC32C_CLASS; |
| 30 | + |
| 31 | + static { |
| 32 | + Class<?> clazz = null; |
| 33 | + boolean available = false; |
| 34 | + try { |
| 35 | + clazz = Class.forName("java.util.zip.CRC32C"); |
| 36 | + // Verify we can instantiate it |
| 37 | + clazz.getDeclaredConstructor().newInstance(); |
| 38 | + available = true; |
| 39 | + } catch (Exception ignored) { |
| 40 | + // JDK CRC32C not available, will use software fallback |
| 41 | + } |
| 42 | + JDK_CRC32C_CLASS = clazz; |
| 43 | + JDK_CRC32C_AVAILABLE = available; |
| 44 | + } |
| 45 | + |
| 46 | + /** |
| 47 | + * Returns true if the JDK's hardware-accelerated CRC32C is being used. |
| 48 | + * Useful for diagnostics and testing. |
| 49 | + * |
| 50 | + * @return true if hardware acceleration is available and in use |
| 51 | + */ |
| 52 | + public static boolean isHardwareAccelerated() { |
| 53 | + return JDK_CRC32C_AVAILABLE; |
| 54 | + } |
82 | 55 |
|
| 56 | + // Delegate to JDK implementation when available |
| 57 | + private final Checksum delegate; |
| 58 | + |
| 59 | + // Software implementation state (used only when JDK not available) |
83 | 60 | private long crc; |
84 | 61 |
|
85 | 62 | public CRC32C() { |
86 | | - crc = 0; |
| 63 | + if (JDK_CRC32C_AVAILABLE) { |
| 64 | + try { |
| 65 | + delegate = (Checksum) JDK_CRC32C_CLASS.getDeclaredConstructor().newInstance(); |
| 66 | + } catch (Exception e) { |
| 67 | + // Should never happen since we verified in static init |
| 68 | + throw new RuntimeException("Failed to instantiate JDK CRC32C", e); |
| 69 | + } |
| 70 | + crc = 0; // unused but must initialize |
| 71 | + } else { |
| 72 | + delegate = null; |
| 73 | + crc = 0; |
| 74 | + } |
87 | 75 | } |
88 | 76 |
|
89 | | - /** |
90 | | - * Updates the checksum with a new byte. |
91 | | - * @param b the new byte. |
92 | | - */ |
93 | 77 | @Override |
94 | 78 | public void update(int b) { |
95 | | - long newCrc = crc ^ LONG_MASK; |
96 | | - newCrc = updateByte((byte) b, newCrc); |
97 | | - crc = newCrc ^ LONG_MASK; |
| 79 | + if (delegate != null) { |
| 80 | + delegate.update(b); |
| 81 | + } else { |
| 82 | + long newCrc = crc ^ LONG_MASK; |
| 83 | + newCrc = updateByte((byte) b, newCrc); |
| 84 | + crc = newCrc ^ LONG_MASK; |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + @Override |
| 89 | + public void update(byte[] bArray, int off, int len) { |
| 90 | + if (delegate != null) { |
| 91 | + delegate.update(bArray, off, len); |
| 92 | + } else { |
| 93 | + updateSoftware(bArray, off, len); |
| 94 | + } |
98 | 95 | } |
99 | 96 |
|
100 | 97 | /** |
101 | | - * Updates the checksum with an array of bytes. |
102 | | - * @param bArray the array of bytes. |
103 | | - * @param off the offset into the array where the update should begin. |
104 | | - * @param len the length of data to examine. |
| 98 | + * Updates the checksum with the entire byte array. |
| 99 | + * Convenience method that delegates to update(byte[], int, int). |
| 100 | + * |
| 101 | + * @param bArray the byte array to update with |
105 | 102 | */ |
| 103 | + public void update(byte[] bArray) { |
| 104 | + update(bArray, 0, bArray.length); |
| 105 | + } |
| 106 | + |
106 | 107 | @Override |
107 | | - public void update(byte[] bArray, int off, int len) { |
| 108 | + public long getValue() { |
| 109 | + if (delegate != null) { |
| 110 | + return delegate.getValue(); |
| 111 | + } |
| 112 | + return crc; |
| 113 | + } |
| 114 | + |
| 115 | + @Override |
| 116 | + public void reset() { |
| 117 | + if (delegate != null) { |
| 118 | + delegate.reset(); |
| 119 | + } else { |
| 120 | + crc = 0; |
| 121 | + } |
| 122 | + } |
| 123 | + |
| 124 | + // ========== Software Implementation ========== |
| 125 | + |
| 126 | + private static final long[] CRC_TABLE = { |
| 127 | + 0x00000000L, 0xf26b8303L, 0xe13b70f7L, 0x1350f3f4L, |
| 128 | + 0xc79a971fL, 0x35f1141cL, 0x26a1e7e8L, 0xd4ca64ebL, |
| 129 | + 0x8ad958cfL, 0x78b2dbccL, 0x6be22838L, 0x9989ab3bL, |
| 130 | + 0x4d43cfd0L, 0xbf284cd3L, 0xac78bf27L, 0x5e133c24L, |
| 131 | + 0x105ec76fL, 0xe235446cL, 0xf165b798L, 0x030e349bL, |
| 132 | + 0xd7c45070L, 0x25afd373L, 0x36ff2087L, 0xc494a384L, |
| 133 | + 0x9a879fa0L, 0x68ec1ca3L, 0x7bbcef57L, 0x89d76c54L, |
| 134 | + 0x5d1d08bfL, 0xaf768bbcL, 0xbc267848L, 0x4e4dfb4bL, |
| 135 | + 0x20bd8edeL, 0xd2d60dddL, 0xc186fe29L, 0x33ed7d2aL, |
| 136 | + 0xe72719c1L, 0x154c9ac2L, 0x061c6936L, 0xf477ea35L, |
| 137 | + 0xaa64d611L, 0x580f5512L, 0x4b5fa6e6L, 0xb93425e5L, |
| 138 | + 0x6dfe410eL, 0x9f95c20dL, 0x8cc531f9L, 0x7eaeb2faL, |
| 139 | + 0x30e349b1L, 0xc288cab2L, 0xd1d83946L, 0x23b3ba45L, |
| 140 | + 0xf779deaeL, 0x05125dadL, 0x1642ae59L, 0xe4292d5aL, |
| 141 | + 0xba3a117eL, 0x4851927dL, 0x5b016189L, 0xa96ae28aL, |
| 142 | + 0x7da08661L, 0x8fcb0562L, 0x9c9bf696L, 0x6ef07595L, |
| 143 | + 0x417b1dbcL, 0xb3109ebfL, 0xa0406d4bL, 0x522bee48L, |
| 144 | + 0x86e18aa3L, 0x748a09a0L, 0x67dafa54L, 0x95b17957L, |
| 145 | + 0xcba24573L, 0x39c9c670L, 0x2a993584L, 0xd8f2b687L, |
| 146 | + 0x0c38d26cL, 0xfe53516fL, 0xed03a29bL, 0x1f682198L, |
| 147 | + 0x5125dad3L, 0xa34e59d0L, 0xb01eaa24L, 0x42752927L, |
| 148 | + 0x96bf4dccL, 0x64d4cecfL, 0x77843d3bL, 0x85efbe38L, |
| 149 | + 0xdbfc821cL, 0x2997011fL, 0x3ac7f2ebL, 0xc8ac71e8L, |
| 150 | + 0x1c661503L, 0xee0d9600L, 0xfd5d65f4L, 0x0f36e6f7L, |
| 151 | + 0x61c69362L, 0x93ad1061L, 0x80fde395L, 0x72966096L, |
| 152 | + 0xa65c047dL, 0x5437877eL, 0x4767748aL, 0xb50cf789L, |
| 153 | + 0xeb1fcbadL, 0x197448aeL, 0x0a24bb5aL, 0xf84f3859L, |
| 154 | + 0x2c855cb2L, 0xdeeedfb1L, 0xcdbe2c45L, 0x3fd5af46L, |
| 155 | + 0x7198540dL, 0x83f3d70eL, 0x90a324faL, 0x62c8a7f9L, |
| 156 | + 0xb602c312L, 0x44694011L, 0x5739b3e5L, 0xa55230e6L, |
| 157 | + 0xfb410cc2L, 0x092a8fc1L, 0x1a7a7c35L, 0xe811ff36L, |
| 158 | + 0x3cdb9bddL, 0xceb018deL, 0xdde0eb2aL, 0x2f8b6829L, |
| 159 | + 0x82f63b78L, 0x709db87bL, 0x63cd4b8fL, 0x91a6c88cL, |
| 160 | + 0x456cac67L, 0xb7072f64L, 0xa457dc90L, 0x563c5f93L, |
| 161 | + 0x082f63b7L, 0xfa44e0b4L, 0xe9141340L, 0x1b7f9043L, |
| 162 | + 0xcfb5f4a8L, 0x3dde77abL, 0x2e8e845fL, 0xdce5075cL, |
| 163 | + 0x92a8fc17L, 0x60c37f14L, 0x73938ce0L, 0x81f80fe3L, |
| 164 | + 0x55326b08L, 0xa759e80bL, 0xb4091bffL, 0x466298fcL, |
| 165 | + 0x1871a4d8L, 0xea1a27dbL, 0xf94ad42fL, 0x0b21572cL, |
| 166 | + 0xdfeb33c7L, 0x2d80b0c4L, 0x3ed04330L, 0xccbbc033L, |
| 167 | + 0xa24bb5a6L, 0x502036a5L, 0x4370c551L, 0xb11b4652L, |
| 168 | + 0x65d122b9L, 0x97baa1baL, 0x84ea524eL, 0x7681d14dL, |
| 169 | + 0x2892ed69L, 0xdaf96e6aL, 0xc9a99d9eL, 0x3bc21e9dL, |
| 170 | + 0xef087a76L, 0x1d63f975L, 0x0e330a81L, 0xfc588982L, |
| 171 | + 0xb21572c9L, 0x407ef1caL, 0x532e023eL, 0xa145813dL, |
| 172 | + 0x758fe5d6L, 0x87e466d5L, 0x94b49521L, 0x66df1622L, |
| 173 | + 0x38cc2a06L, 0xcaa7a905L, 0xd9f75af1L, 0x2b9cd9f2L, |
| 174 | + 0xff56bd19L, 0x0d3d3e1aL, 0x1e6dcdeeL, 0xec064eedL, |
| 175 | + 0xc38d26c4L, 0x31e6a5c7L, 0x22b65633L, 0xd0ddd530L, |
| 176 | + 0x0417b1dbL, 0xf67c32d8L, 0xe52cc12cL, 0x1747422fL, |
| 177 | + 0x49547e0bL, 0xbb3ffd08L, 0xa86f0efcL, 0x5a048dffL, |
| 178 | + 0x8ecee914L, 0x7ca56a17L, 0x6ff599e3L, 0x9d9e1ae0L, |
| 179 | + 0xd3d3e1abL, 0x21b862a8L, 0x32e8915cL, 0xc083125fL, |
| 180 | + 0x144976b4L, 0xe622f5b7L, 0xf5720643L, 0x07198540L, |
| 181 | + 0x590ab964L, 0xab613a67L, 0xb831c993L, 0x4a5a4a90L, |
| 182 | + 0x9e902e7bL, 0x6cfbad78L, 0x7fab5e8cL, 0x8dc0dd8fL, |
| 183 | + 0xe330a81aL, 0x115b2b19L, 0x020bd8edL, 0xf0605beeL, |
| 184 | + 0x24aa3f05L, 0xd6c1bc06L, 0xc5914ff2L, 0x37faccf1L, |
| 185 | + 0x69e9f0d5L, 0x9b8273d6L, 0x88d28022L, 0x7ab90321L, |
| 186 | + 0xae7367caL, 0x5c18e4c9L, 0x4f48173dL, 0xbd23943eL, |
| 187 | + 0xf36e6f75L, 0x0105ec76L, 0x12551f82L, 0xe03e9c81L, |
| 188 | + 0x34f4f86aL, 0xc69f7b69L, 0xd5cf889dL, 0x27a40b9eL, |
| 189 | + 0x79b737baL, 0x8bdcb4b9L, 0x988c474dL, 0x6ae7c44eL, |
| 190 | + 0xbe2da0a5L, 0x4c4623a6L, 0x5f16d052L, 0xad7d5351L |
| 191 | + }; |
| 192 | + |
| 193 | + private static final long LONG_MASK = 0xffffffffL; |
| 194 | + private static final long BYTE_MASK = 0xffL; |
| 195 | + |
| 196 | + private void updateSoftware(byte[] bArray, int off, int len) { |
108 | 197 | long newCrc = crc ^ LONG_MASK; |
109 | 198 | int end = off + len; |
110 | | - |
| 199 | + |
111 | 200 | // Process 8 bytes at a time for better performance |
112 | 201 | int fastEnd = end - 7; |
113 | 202 | int i = off; |
114 | 203 | while (i < fastEnd) { |
115 | | - // Process a block of 8 bytes using inner loop |
116 | | - for (int j = 0; j < 8; j++) { |
117 | | - newCrc = updateByte(bArray[i + j], newCrc); |
118 | | - } |
| 204 | + newCrc = updateByte(bArray[i], newCrc); |
| 205 | + newCrc = updateByte(bArray[i + 1], newCrc); |
| 206 | + newCrc = updateByte(bArray[i + 2], newCrc); |
| 207 | + newCrc = updateByte(bArray[i + 3], newCrc); |
| 208 | + newCrc = updateByte(bArray[i + 4], newCrc); |
| 209 | + newCrc = updateByte(bArray[i + 5], newCrc); |
| 210 | + newCrc = updateByte(bArray[i + 6], newCrc); |
| 211 | + newCrc = updateByte(bArray[i + 7], newCrc); |
119 | 212 | i += 8; |
120 | 213 | } |
121 | | - |
| 214 | + |
122 | 215 | // Process remaining bytes |
123 | 216 | while (i < end) { |
124 | 217 | newCrc = updateByte(bArray[i], newCrc); |
125 | 218 | i++; |
126 | 219 | } |
127 | | - |
128 | | - crc = newCrc ^ LONG_MASK; |
129 | | - } |
130 | | - |
131 | | - /** |
132 | | - * Returns the value of the checksum. |
133 | | - * @return the long representation of the checksum (high bits set to zero). |
134 | | - */ |
135 | | - @Override |
136 | | - public long getValue() { |
137 | | - return crc; |
138 | | - } |
139 | 220 |
|
140 | | - /** |
141 | | - * Resets the crc. |
142 | | - */ |
143 | | - @Override |
144 | | - public void reset() { |
145 | | - crc = 0; |
| 221 | + crc = newCrc ^ LONG_MASK; |
146 | 222 | } |
147 | 223 |
|
148 | | - private long updateByte(byte newByte, long crc) { |
149 | | - byte b = (byte) (newByte & BYTE_MASK); |
150 | | - int index = (int) ((crc ^ b) & BYTE_MASK); |
151 | | - return (CRC_TABLE[index] ^ (crc >> 8)) & LONG_MASK; |
| 224 | + private static long updateByte(byte newByte, long crc) { |
| 225 | + int index = (int) ((crc ^ newByte) & BYTE_MASK); |
| 226 | + return (CRC_TABLE[index] ^ (crc >>> 8)) & LONG_MASK; |
152 | 227 | } |
153 | 228 | } |
0 commit comments