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 #ifndef _UCW_CRC_H
  20 #define _UCW_CRC_H
  21
  22 /**
  23  * Internal CRC calculator context.
  24  * You should use it just as an opaque handle only.
  25  */
  26 typedef struct crc32_context {
  27   u32 state;
  28   void (*update_func)(struct crc32_context *ctx, const byte *buf, uns len);
  29 } crc32_context;
  30
  31 /**
  32  * Initialize new calculation of CRC in a given context.
  33  * @crc_mode selects which algorithm should be used.
  34  **/
  35 void crc32_init(crc32_context *ctx, uns crc_mode);
  36
  37 /**
  38  * Algorithm used for CRC calculation. The algorithms differ by the amount
  39  * of precomputed tables they use. Bigger tables imply faster calculation
  40  * at the cost of an increased cache footprint.
  41  **/
  42 enum crc_mode {
  43   CRC_MODE_DEFAULT,             /* Default algorithm (4K table) */
  44   CRC_MODE_SMALL,               /* Optimize for small data (1K table) */
  45   CRC_MODE_BIG,                 /* Optimize for large data (8K table) */
  46   CRC_MODE_MAX,
  47 };
  48
  49 /** Feed @len bytes starting at @buf to the CRC calculator. **/
  50 static inline void crc32_update(crc32_context *ctx, const byte *buf, uns len)
  51 {
  52   ctx->update_func(ctx, buf, len);
  53 }
  54
  55 /** Finish calculation and return the CRC value. **/
  56 static inline u32 crc32_final(crc32_context *ctx)
  57 {
  58   return ctx->state ^ 0xffffffff;
  59 }
  60
  61 /**
  62  * A convenience one-shot function for CRC.
  63  * It is equivalent to this snippet of code:
  64  *
  65  *  crc32_context ctx;
  66  *  crc32_init(&ctx, CRC_MODE_DEFAULT);
  67  *  crc32_update(&ctx, buf, len);
  68  *  return crc32_final(&ctx);
  69  */
  70 u32 crc32_hash_buffer(const byte *buf, uns len);
  71
  72 #endif