| 1 | /* $Id: crc64.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - CRC64.
|
|---|
| 4 | *
|
|---|
| 5 | * The method to compute the CRC64 is referred to as CRC-64-ISO:
|
|---|
| 6 | * http://en.wikipedia.org/wiki/Cyclic_redundancy_check
|
|---|
| 7 | * The generator polynomial is x^64 + x^4 + x^3 + x + 1.
|
|---|
| 8 | * Reverse polynom: 0xd800000000000000ULL
|
|---|
| 9 | */
|
|---|
| 10 |
|
|---|
| 11 | /*
|
|---|
| 12 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 13 | *
|
|---|
| 14 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 15 | * available from https://www.virtualbox.org.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is free software; you can redistribute it and/or
|
|---|
| 18 | * modify it under the terms of the GNU General Public License
|
|---|
| 19 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 20 | * License.
|
|---|
| 21 | *
|
|---|
| 22 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 23 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 25 | * General Public License for more details.
|
|---|
| 26 | *
|
|---|
| 27 | * You should have received a copy of the GNU General Public License
|
|---|
| 28 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 29 | *
|
|---|
| 30 | * The contents of this file may alternatively be used under the terms
|
|---|
| 31 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 32 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 33 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 34 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 35 | *
|
|---|
| 36 | * You may elect to license modified versions of this file under the
|
|---|
| 37 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 38 | *
|
|---|
| 39 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 40 | */
|
|---|
| 41 |
|
|---|
| 42 |
|
|---|
| 43 | /*********************************************************************************************************************************
|
|---|
| 44 | * Header Files *
|
|---|
| 45 | *********************************************************************************************************************************/
|
|---|
| 46 | #include <iprt/crc.h>
|
|---|
| 47 | #include "internal/iprt.h"
|
|---|
| 48 |
|
|---|
| 49 |
|
|---|
| 50 | /*********************************************************************************************************************************
|
|---|
| 51 | * Global Variables *
|
|---|
| 52 | *********************************************************************************************************************************/
|
|---|
| 53 | /**
|
|---|
| 54 | * Lookup table (precomputed CRC64 values for each 8 bit string) computation
|
|---|
| 55 | * takes into account the fact that the reverse polynom has zeros in lower 8 bits:
|
|---|
| 56 | *
|
|---|
| 57 | * @code
|
|---|
| 58 | * for (i = 0; i < 256; i++)
|
|---|
| 59 | * {
|
|---|
| 60 | * shiftRegister = i;
|
|---|
| 61 | * for (j = 0; j < 8; j++)
|
|---|
| 62 | * {
|
|---|
| 63 | * if (shiftRegister & 1)
|
|---|
| 64 | * shiftRegister = (shiftRegister >> 1) ^ Reverse_polynom;
|
|---|
| 65 | * else
|
|---|
| 66 | * shiftRegister >>= 1;
|
|---|
| 67 | * }
|
|---|
| 68 | * CRCTable[i] = shiftRegister;
|
|---|
| 69 | * }
|
|---|
| 70 | * @endcode
|
|---|
| 71 | *
|
|---|
| 72 | * Generic code would look as follows:
|
|---|
| 73 | *
|
|---|
| 74 | * @code
|
|---|
| 75 | * for (i = 0; i < 256; i++)
|
|---|
| 76 | * {
|
|---|
| 77 | * shiftRegister = 0;
|
|---|
| 78 | * bitString = i;
|
|---|
| 79 | * for (j = 0; j < 8; j++)
|
|---|
| 80 | * {
|
|---|
| 81 | * if ((shiftRegister ^ (bitString >> j)) & 1)
|
|---|
| 82 | * shiftRegister = (shiftRegister >> 1) ^ Reverse_polynom;
|
|---|
| 83 | * else
|
|---|
| 84 | * shiftRegister >>= 1;
|
|---|
| 85 | * }
|
|---|
| 86 | * CRCTable[i] = shiftRegister;
|
|---|
| 87 | * }
|
|---|
| 88 | * @endcode
|
|---|
| 89 | *
|
|---|
| 90 | * @remark Since the lookup table elements have 0 in the lower 32 bit word,
|
|---|
| 91 | * the 32 bit assembler implementation of CRC64Process can be optimized,
|
|---|
| 92 | * avoiding at least one 'xor' operation.
|
|---|
| 93 | */
|
|---|
| 94 | static const uint64_t g_au64CRC64[] =
|
|---|
| 95 | {
|
|---|
| 96 | 0x0000000000000000ULL, 0x01B0000000000000ULL, 0x0360000000000000ULL, 0x02D0000000000000ULL,
|
|---|
| 97 | 0x06C0000000000000ULL, 0x0770000000000000ULL, 0x05A0000000000000ULL, 0x0410000000000000ULL,
|
|---|
| 98 | 0x0D80000000000000ULL, 0x0C30000000000000ULL, 0x0EE0000000000000ULL, 0x0F50000000000000ULL,
|
|---|
| 99 | 0x0B40000000000000ULL, 0x0AF0000000000000ULL, 0x0820000000000000ULL, 0x0990000000000000ULL,
|
|---|
| 100 | 0x1B00000000000000ULL, 0x1AB0000000000000ULL, 0x1860000000000000ULL, 0x19D0000000000000ULL,
|
|---|
| 101 | 0x1DC0000000000000ULL, 0x1C70000000000000ULL, 0x1EA0000000000000ULL, 0x1F10000000000000ULL,
|
|---|
| 102 | 0x1680000000000000ULL, 0x1730000000000000ULL, 0x15E0000000000000ULL, 0x1450000000000000ULL,
|
|---|
| 103 | 0x1040000000000000ULL, 0x11F0000000000000ULL, 0x1320000000000000ULL, 0x1290000000000000ULL,
|
|---|
| 104 | 0x3600000000000000ULL, 0x37B0000000000000ULL, 0x3560000000000000ULL, 0x34D0000000000000ULL,
|
|---|
| 105 | 0x30C0000000000000ULL, 0x3170000000000000ULL, 0x33A0000000000000ULL, 0x3210000000000000ULL,
|
|---|
| 106 | 0x3B80000000000000ULL, 0x3A30000000000000ULL, 0x38E0000000000000ULL, 0x3950000000000000ULL,
|
|---|
| 107 | 0x3D40000000000000ULL, 0x3CF0000000000000ULL, 0x3E20000000000000ULL, 0x3F90000000000000ULL,
|
|---|
| 108 | 0x2D00000000000000ULL, 0x2CB0000000000000ULL, 0x2E60000000000000ULL, 0x2FD0000000000000ULL,
|
|---|
| 109 | 0x2BC0000000000000ULL, 0x2A70000000000000ULL, 0x28A0000000000000ULL, 0x2910000000000000ULL,
|
|---|
| 110 | 0x2080000000000000ULL, 0x2130000000000000ULL, 0x23E0000000000000ULL, 0x2250000000000000ULL,
|
|---|
| 111 | 0x2640000000000000ULL, 0x27F0000000000000ULL, 0x2520000000000000ULL, 0x2490000000000000ULL,
|
|---|
| 112 | 0x6C00000000000000ULL, 0x6DB0000000000000ULL, 0x6F60000000000000ULL, 0x6ED0000000000000ULL,
|
|---|
| 113 | 0x6AC0000000000000ULL, 0x6B70000000000000ULL, 0x69A0000000000000ULL, 0x6810000000000000ULL,
|
|---|
| 114 | 0x6180000000000000ULL, 0x6030000000000000ULL, 0x62E0000000000000ULL, 0x6350000000000000ULL,
|
|---|
| 115 | 0x6740000000000000ULL, 0x66F0000000000000ULL, 0x6420000000000000ULL, 0x6590000000000000ULL,
|
|---|
| 116 | 0x7700000000000000ULL, 0x76B0000000000000ULL, 0x7460000000000000ULL, 0x75D0000000000000ULL,
|
|---|
| 117 | 0x71C0000000000000ULL, 0x7070000000000000ULL, 0x72A0000000000000ULL, 0x7310000000000000ULL,
|
|---|
| 118 | 0x7A80000000000000ULL, 0x7B30000000000000ULL, 0x79E0000000000000ULL, 0x7850000000000000ULL,
|
|---|
| 119 | 0x7C40000000000000ULL, 0x7DF0000000000000ULL, 0x7F20000000000000ULL, 0x7E90000000000000ULL,
|
|---|
| 120 | 0x5A00000000000000ULL, 0x5BB0000000000000ULL, 0x5960000000000000ULL, 0x58D0000000000000ULL,
|
|---|
| 121 | 0x5CC0000000000000ULL, 0x5D70000000000000ULL, 0x5FA0000000000000ULL, 0x5E10000000000000ULL,
|
|---|
| 122 | 0x5780000000000000ULL, 0x5630000000000000ULL, 0x54E0000000000000ULL, 0x5550000000000000ULL,
|
|---|
| 123 | 0x5140000000000000ULL, 0x50F0000000000000ULL, 0x5220000000000000ULL, 0x5390000000000000ULL,
|
|---|
| 124 | 0x4100000000000000ULL, 0x40B0000000000000ULL, 0x4260000000000000ULL, 0x43D0000000000000ULL,
|
|---|
| 125 | 0x47C0000000000000ULL, 0x4670000000000000ULL, 0x44A0000000000000ULL, 0x4510000000000000ULL,
|
|---|
| 126 | 0x4C80000000000000ULL, 0x4D30000000000000ULL, 0x4FE0000000000000ULL, 0x4E50000000000000ULL,
|
|---|
| 127 | 0x4A40000000000000ULL, 0x4BF0000000000000ULL, 0x4920000000000000ULL, 0x4890000000000000ULL,
|
|---|
| 128 | 0xD800000000000000ULL, 0xD9B0000000000000ULL, 0xDB60000000000000ULL, 0xDAD0000000000000ULL,
|
|---|
| 129 | 0xDEC0000000000000ULL, 0xDF70000000000000ULL, 0xDDA0000000000000ULL, 0xDC10000000000000ULL,
|
|---|
| 130 | 0xD580000000000000ULL, 0xD430000000000000ULL, 0xD6E0000000000000ULL, 0xD750000000000000ULL,
|
|---|
| 131 | 0xD340000000000000ULL, 0xD2F0000000000000ULL, 0xD020000000000000ULL, 0xD190000000000000ULL,
|
|---|
| 132 | 0xC300000000000000ULL, 0xC2B0000000000000ULL, 0xC060000000000000ULL, 0xC1D0000000000000ULL,
|
|---|
| 133 | 0xC5C0000000000000ULL, 0xC470000000000000ULL, 0xC6A0000000000000ULL, 0xC710000000000000ULL,
|
|---|
| 134 | 0xCE80000000000000ULL, 0xCF30000000000000ULL, 0xCDE0000000000000ULL, 0xCC50000000000000ULL,
|
|---|
| 135 | 0xC840000000000000ULL, 0xC9F0000000000000ULL, 0xCB20000000000000ULL, 0xCA90000000000000ULL,
|
|---|
| 136 | 0xEE00000000000000ULL, 0xEFB0000000000000ULL, 0xED60000000000000ULL, 0xECD0000000000000ULL,
|
|---|
| 137 | 0xE8C0000000000000ULL, 0xE970000000000000ULL, 0xEBA0000000000000ULL, 0xEA10000000000000ULL,
|
|---|
| 138 | 0xE380000000000000ULL, 0xE230000000000000ULL, 0xE0E0000000000000ULL, 0xE150000000000000ULL,
|
|---|
| 139 | 0xE540000000000000ULL, 0xE4F0000000000000ULL, 0xE620000000000000ULL, 0xE790000000000000ULL,
|
|---|
| 140 | 0xF500000000000000ULL, 0xF4B0000000000000ULL, 0xF660000000000000ULL, 0xF7D0000000000000ULL,
|
|---|
| 141 | 0xF3C0000000000000ULL, 0xF270000000000000ULL, 0xF0A0000000000000ULL, 0xF110000000000000ULL,
|
|---|
| 142 | 0xF880000000000000ULL, 0xF930000000000000ULL, 0xFBE0000000000000ULL, 0xFA50000000000000ULL,
|
|---|
| 143 | 0xFE40000000000000ULL, 0xFFF0000000000000ULL, 0xFD20000000000000ULL, 0xFC90000000000000ULL,
|
|---|
| 144 | 0xB400000000000000ULL, 0xB5B0000000000000ULL, 0xB760000000000000ULL, 0xB6D0000000000000ULL,
|
|---|
| 145 | 0xB2C0000000000000ULL, 0xB370000000000000ULL, 0xB1A0000000000000ULL, 0xB010000000000000ULL,
|
|---|
| 146 | 0xB980000000000000ULL, 0xB830000000000000ULL, 0xBAE0000000000000ULL, 0xBB50000000000000ULL,
|
|---|
| 147 | 0xBF40000000000000ULL, 0xBEF0000000000000ULL, 0xBC20000000000000ULL, 0xBD90000000000000ULL,
|
|---|
| 148 | 0xAF00000000000000ULL, 0xAEB0000000000000ULL, 0xAC60000000000000ULL, 0xADD0000000000000ULL,
|
|---|
| 149 | 0xA9C0000000000000ULL, 0xA870000000000000ULL, 0xAAA0000000000000ULL, 0xAB10000000000000ULL,
|
|---|
| 150 | 0xA280000000000000ULL, 0xA330000000000000ULL, 0xA1E0000000000000ULL, 0xA050000000000000ULL,
|
|---|
| 151 | 0xA440000000000000ULL, 0xA5F0000000000000ULL, 0xA720000000000000ULL, 0xA690000000000000ULL,
|
|---|
| 152 | 0x8200000000000000ULL, 0x83B0000000000000ULL, 0x8160000000000000ULL, 0x80D0000000000000ULL,
|
|---|
| 153 | 0x84C0000000000000ULL, 0x8570000000000000ULL, 0x87A0000000000000ULL, 0x8610000000000000ULL,
|
|---|
| 154 | 0x8F80000000000000ULL, 0x8E30000000000000ULL, 0x8CE0000000000000ULL, 0x8D50000000000000ULL,
|
|---|
| 155 | 0x8940000000000000ULL, 0x88F0000000000000ULL, 0x8A20000000000000ULL, 0x8B90000000000000ULL,
|
|---|
| 156 | 0x9900000000000000ULL, 0x98B0000000000000ULL, 0x9A60000000000000ULL, 0x9BD0000000000000ULL,
|
|---|
| 157 | 0x9FC0000000000000ULL, 0x9E70000000000000ULL, 0x9CA0000000000000ULL, 0x9D10000000000000ULL,
|
|---|
| 158 | 0x9480000000000000ULL, 0x9530000000000000ULL, 0x97E0000000000000ULL, 0x9650000000000000ULL,
|
|---|
| 159 | 0x9240000000000000ULL, 0x93F0000000000000ULL, 0x9120000000000000ULL, 0x9090000000000000ULL
|
|---|
| 160 | };
|
|---|
| 161 |
|
|---|
| 162 |
|
|---|
| 163 | /**
|
|---|
| 164 | * Calculate CRC64 for a memory block.
|
|---|
| 165 | *
|
|---|
| 166 | * @returns CRC64 for the memory block.
|
|---|
| 167 | * @param pv Pointer to the memory block.
|
|---|
| 168 | * @param cb Size of the memory block in bytes.
|
|---|
| 169 | */
|
|---|
| 170 | RTDECL(uint64_t) RTCrc64(const void *pv, size_t cb)
|
|---|
| 171 | {
|
|---|
| 172 | const uint8_t *pu8 = (const uint8_t *)pv;
|
|---|
| 173 | uint64_t uCRC64 = 0ULL;
|
|---|
| 174 | while (cb--)
|
|---|
| 175 | uCRC64 = g_au64CRC64[(uCRC64 ^ *pu8++) & 0xff] ^ (uCRC64 >> 8);
|
|---|
| 176 | return uCRC64;
|
|---|
| 177 | }
|
|---|
| 178 | RT_EXPORT_SYMBOL(RTCrc64);
|
|---|
| 179 |
|
|---|
| 180 |
|
|---|
| 181 | /**
|
|---|
| 182 | * Start a multiblock CRC64 calculation.
|
|---|
| 183 | *
|
|---|
| 184 | * @returns Start CRC64.
|
|---|
| 185 | */
|
|---|
| 186 | RTDECL(uint64_t) RTCrc64Start(void)
|
|---|
| 187 | {
|
|---|
| 188 | return 0ULL;
|
|---|
| 189 | }
|
|---|
| 190 | RT_EXPORT_SYMBOL(RTCrc64Start);
|
|---|
| 191 |
|
|---|
| 192 |
|
|---|
| 193 | /**
|
|---|
| 194 | * Processes a multiblock of a CRC64 calculation.
|
|---|
| 195 | *
|
|---|
| 196 | * @returns Intermediate CRC64 value.
|
|---|
| 197 | * @param uCRC64 Current CRC64 intermediate value.
|
|---|
| 198 | * @param pv The data block to process.
|
|---|
| 199 | * @param cb The size of the data block in bytes.
|
|---|
| 200 | */
|
|---|
| 201 | RTDECL(uint64_t) RTCrc64Process(uint64_t uCRC64, const void *pv, size_t cb)
|
|---|
| 202 | {
|
|---|
| 203 | const uint8_t *pu8 = (const uint8_t *)pv;
|
|---|
| 204 | while (cb--)
|
|---|
| 205 | uCRC64 = g_au64CRC64[(uCRC64 ^ *pu8++) & 0xff] ^ (uCRC64 >> 8);
|
|---|
| 206 | return uCRC64;
|
|---|
| 207 | }
|
|---|
| 208 | RT_EXPORT_SYMBOL(RTCrc64Process);
|
|---|
| 209 |
|
|---|
| 210 |
|
|---|
| 211 | /**
|
|---|
| 212 | * Complete a multiblock CRC64 calculation.
|
|---|
| 213 | *
|
|---|
| 214 | * @returns CRC64 value.
|
|---|
| 215 | * @param uCRC64 Current CRC64 intermediate value.
|
|---|
| 216 | */
|
|---|
| 217 | RTDECL(uint64_t) RTCrc64Finish(uint64_t uCRC64)
|
|---|
| 218 | {
|
|---|
| 219 | return uCRC64;
|
|---|
| 220 | }
|
|---|
| 221 | RT_EXPORT_SYMBOL(RTCrc64Finish);
|
|---|
| 222 |
|
|---|
