lib/librte_hash/rte_hash_crc.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   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 #ifndef _RTE_HASH_CRC_H_
  35 #define _RTE_HASH_CRC_H_
  36
  37 /**
  38  * @file
  39  *
  40  * RTE CRC Hash
  41  */
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #include <stdint.h>
  48 #include <nmmintrin.h>
  49
  50 /**
  51  * Use single crc32 instruction to perform a hash on a 4 byte value.
  52  *
  53  * @param data
  54  *   Data to perform hash on.
  55  * @param init_val
  56  *   Value to initialise hash generator.
  57  * @return
  58  *   32bit calculated hash value.
  59  */
  60 static inline uint32_t
  61 rte_hash_crc_4byte(uint32_t data, uint32_t init_val)
  62 {
  63         return _mm_crc32_u32(data, init_val);
  64 }
  65
  66 /**
  67  * Use crc32 instruction to perform a hash.
  68  *
  69  * @param data
  70  *   Data to perform hash on.
  71  * @param data_len
  72  *   How many bytes to use to calculate hash value.
  73  * @param init_val
  74  *   Value to initialise hash generator.
  75  * @return
  76  *   32bit calculated hash value.
  77  */
  78 static inline uint32_t
  79 rte_hash_crc(const void *data, uint32_t data_len, uint32_t init_val)
  80 {
  81         unsigned i;
  82         uint32_t temp = 0;
  83         const uint32_t *p32 = (const uint32_t *)data;
  84
  85         for (i = 0; i < data_len / 4; i++) {
  86                 init_val = rte_hash_crc_4byte(*p32++, init_val);
  87         }
  88
  89         switch (3 - (data_len & 0x03)) {
  90         case 0:
  91                 temp |= *((const uint8_t *)p32 + 2) << 16;
  92                 /* Fallthrough */
  93         case 1:
  94                 temp |= *((const uint8_t *)p32 + 1) << 8;
  95                 /* Fallthrough */
  96         case 2:
  97                 temp |= *((const uint8_t *)p32);
  98                 init_val = rte_hash_crc_4byte(temp, init_val);
  99         default:
 100                 break;
 101         }
 102
 103         return init_val;
 104 }
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif /* _RTE_HASH_CRC_H_ */