lib/librte_hash/rte_hash_crc.h

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