5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @file
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * IPRT - CRCs and Checksums.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/*
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2010 Oracle Corporation
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * available from http://www.virtualbox.org. This file is free software;
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * you can redistribute it and/or modify it under the terms of the GNU
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * General Public License (GPL) as published by the Free Software
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * The contents of this file may alternatively be used under the terms
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * of the Common Development and Distribution License Version 1.0
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * VirtualBox OSE distribution, in which case the provisions of the
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * CDDL are applicable instead of those of the GPL.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * You may elect to license modified versions of this file under the
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * terms and conditions of either the GPL or the CDDL or both.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync#ifndef ___iprt_crc_h
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync#define ___iprt_crc_h
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync#include <iprt/cdefs.h>
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync#include <iprt/types.h>
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRT_C_DECLS_BEGIN
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @defgroup grp_rt_crc RTCrc - Checksums and CRCs.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @ingroup grp_rt
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @{
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @defgroup grp_rt_crc32 CRC-32
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @{ */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Calculate CRC-32 for a memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns CRC-32 for the memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param pv Pointer to the memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param cb Size of the memory block in bytes.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrc32(const void *pv, size_t cb);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Start a multiblock CRC-32 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Start CRC-32.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrc32Start(void);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Processes a multiblock of a CRC-32 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Intermediate CRC-32 value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param uCRC32 Current CRC-32 intermediate value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param pv The data block to process.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param cb The size of the data block in bytes.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrc32Process(uint32_t uCRC32, const void *pv, size_t cb);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Complete a multiblock CRC-32 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns CRC-32 value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param uCRC32 Current CRC-32 intermediate value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrc32Finish(uint32_t uCRC32);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @} */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @defgroup grp_rt_crc64 CRC-64 Calculation
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @{ */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Calculate CRC-64 for a memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns CRC-64 for the memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param pv Pointer to the memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param cb Size of the memory block in bytes.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint64_t) RTCrc64(const void *pv, size_t cb);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Start a multiblock CRC-64 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Start CRC-64.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint64_t) RTCrc64Start(void);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Processes a multiblock of a CRC-64 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Intermediate CRC-64 value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param uCRC64 Current CRC-64 intermediate value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param pv The data block to process.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param cb The size of the data block in bytes.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint64_t) RTCrc64Process(uint64_t uCRC64, const void *pv, size_t cb);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Complete a multiblock CRC-64 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns CRC-64 value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param uCRC64 Current CRC-64 intermediate value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint64_t) RTCrc64Finish(uint64_t uCRC64);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @} */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @defgroup grp_rt_crc_adler32 Adler-32
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @{ */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Calculate Adler-32 for a memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Adler-32 for the memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param pv Pointer to the memory block.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param cb Size of the memory block in bytes.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrcAdler32(void const *pv, size_t cb);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Start a multiblock Adler-32 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Start Adler-32.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrcAdler32Start(void);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Processes a multiblock of a Adler-32 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Intermediate Adler-32 value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param uCrc Current Adler-32 intermediate value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param pv The data block to process.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param cb The size of the data block in bytes.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrcAdler32Process(uint32_t uCrc, void const *pv, size_t cb);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/**
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * Complete a multiblock Adler-32 calculation.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync *
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @returns Adler-32 value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync * @param uCrc Current Adler-32 intermediate value.
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRTDECL(uint32_t) RTCrcAdler32Finish(uint32_t uCrc);
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @} */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync/** @defgroup grp_rt_crc32c CRC-32C
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @{ */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync/**
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * Calculate CRC-32C for a memory block.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync *
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @returns CRC-32C for the memory block.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @param pv Pointer to the memory block.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @param cb Size of the memory block in bytes.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsyncRTDECL(uint32_t) RTCrc32C(const void *pv, size_t cb);
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync/**
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * Start a multiblock CRC-32 calculation.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync *
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @returns Start CRC-32.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsyncRTDECL(uint32_t) RTCrc32CStart(void);
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync/**
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * Processes a multiblock of a CRC-32C calculation.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync *
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @returns Intermediate CRC-32C value.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @param uCRC32C Current CRC-32C intermediate value.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @param pv The data block to process.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @param cb The size of the data block in bytes.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsyncRTDECL(uint32_t) RTCrc32CProcess(uint32_t uCRC32C, const void *pv, size_t cb);
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync/**
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * Complete a multiblock CRC-32 calculation.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync *
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @returns CRC-32 value.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync * @param uCRC32 Current CRC-32 intermediate value.
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsyncRTDECL(uint32_t) RTCrc32CFinish(uint32_t uCRC32);
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync/** @} */
73334d216e090057ca9631df4a4bbf8fa5ba529fvboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync/** @} */
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsyncRT_C_DECLS_END
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync#endif
5ae5011f5a5bce195e3f675803b667ec383d57eevboxsync