ucw/crc.h

   1 /*
   2  *      CRC32 (Castagnoli 1993)
   3  *
   4  *      Based on Michael E. Kounavis and Frank L. Berry: A Systematic Approach
   5  *      to Building High Performance Software-based CRC Generators
   6  *      (Proceedings of the 10th IEEE Symposium on Computers and Communications 2005)
   7  *
   8  *      Includes code from http://sourceforge.net/projects/slicing-by-8/,
   9  *      which carried the following copyright notice:
  10  *
  11  *      Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
  12  *
  13  *      This software program is licensed subject to the BSD License,
  14  *      available at http://www.opensource.org/licenses/bsd-license.html
  15  *
  16  *      Adapted for LibUCW by Martin Mares <mj@ucw.cz> in 2012.
  17  */
  18
  19 /**
  20  * Internal CRC calculator context.
  21  * You should use it just as an opaque handle only.
  22  */
  23 typedef struct crc32_context {
  24   u32 state;
  25   void (*update_func)(struct crc32_context *ctx, const byte *buf, uns len);
  26 } crc32_context;
  27
  28 /**
  29  * Initialize new calculation of CRC in a given context.
  30  * @crc_mode selects which algorithm should be used.
  31  **/
  32 void crc32_init(crc32_context *ctx, uns crc_mode);
  33
  34 /**
  35  * Algorithm used for CRC calculation. The algorithms differ by the amount
  36  * of precomputed tables they use. Bigger tables imply faster calculation
  37  * at the cost of an increased cache footprint.
  38  **/
  39 enum crc_mode {
  40   CRC_MODE_DEFAULT,             /* Default algorithm (4K table) */
  41   CRC_MODE_SMALL,               /* Optimize for small data (1K table) */
  42   CRC_MODE_BIG,                 /* Optimize for large data (8K table) */
  43   CRC_MODE_MAX,
  44 };
  45
  46 /** Feed @len bytes starting at @buf to the CRC calculator. **/
  47 static inline void crc32_update(crc32_context *ctx, const byte *buf, uns len)
  48 {
  49   ctx->update_func(ctx, buf, len);
  50 }
  51
  52 /** Finish calculation and return the CRC value. **/
  53 static inline u32 crc32_final(crc32_context *ctx)
  54 {
  55   return ctx->state ^ 0xffffffff;
  56 }