ceph/src/spdk/include/spdk/crc32.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) Intel Corporation.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /**
  35  * \file
  36  * CRC-32 utility functions
  37  */
  38
  39 #ifndef SPDK_CRC32_H
  40 #define SPDK_CRC32_H
  41
  42 #include "spdk/stdinc.h"
  43 #include "spdk/config.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /**
  50  * IEEE CRC-32 polynomial (bit reflected)
  51  */
  52 #define SPDK_CRC32_POLYNOMIAL_REFLECT 0xedb88320UL
  53
  54 /**
  55  * CRC-32C (Castagnoli) polynomial (bit reflected)
  56  */
  57 #define SPDK_CRC32C_POLYNOMIAL_REFLECT 0x82f63b78UL
  58
  59 struct spdk_crc32_table {
  60         uint32_t table[256];
  61 };
  62
  63 /**
  64  * Initialize a CRC32 lookup table for a given polynomial.
  65  *
  66  * \param table Table to fill with precalculated CRC-32 data.
  67  * \param polynomial_reflect Bit-reflected CRC-32 polynomial.
  68  */
  69 void spdk_crc32_table_init(struct spdk_crc32_table *table,
  70                            uint32_t polynomial_reflect);
  71
  72 /**
  73  * Calculate a partial CRC-32 checksum.
  74  *
  75  * \param table CRC-32 table initialized with spdk_crc32_table_init().
  76  * \param buf Data buffer to checksum.
  77  * \param len Length of buf in bytes.
  78  * \param crc Previous CRC-32 value.
  79  * \return Updated CRC-32 value.
  80  */
  81 uint32_t spdk_crc32_update(const struct spdk_crc32_table *table,
  82                            const void *buf, size_t len,
  83                            uint32_t crc);
  84
  85 /**
  86  * Calculate a partial CRC-32 IEEE checksum.
  87  *
  88  * \param buf Data buffer to checksum.
  89  * \param len Length of buf in bytes.
  90  * \param crc Previous CRC-32 value.
  91  * \return Updated CRC-32 value.
  92  */
  93 uint32_t spdk_crc32_ieee_update(const void *buf, size_t len, uint32_t crc);
  94
  95 /**
  96  * Calculate a partial CRC-32C checksum.
  97  *
  98  * \param buf Data buffer to checksum.
  99  * \param len Length of buf in bytes.
 100  * \param crc Previous CRC-32C value.
 101  * \return Updated CRC-32C value.
 102  */
 103 uint32_t spdk_crc32c_update(const void *buf, size_t len, uint32_t crc);
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif /* SPDK_CRC32_H */