numam-dpdk/lib/hash/rte_hash_crc.h
Pavan Nikhilesh f80ae1aa9a hash: unify CRC32 selection for x86 and Arm
Merge CRC32 hash calculation public API implementation for x86 and Arm.
Select the best available CRC32 algorithm when unsupported algorithm
on a given CPU architecture is requested by an application.

Previously, if an application directly includes `rte_crc_arm64.h`
without including `rte_hash_crc.h` it will fail to compile.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
2022-05-19 10:00:51 -04:00

199 lines
4.4 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2010-2014 Intel Corporation
*/
#ifndef _RTE_HASH_CRC_H_
#define _RTE_HASH_CRC_H_
/**
* @file
*
* RTE CRC Hash
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <rte_branch_prediction.h>
#include <rte_common.h>
#include <rte_config.h>
#include <rte_cpuflags.h>
#include <rte_log.h>
#include "rte_crc_sw.h"
#define CRC32_SW (1U << 0)
#define CRC32_SSE42 (1U << 1)
#define CRC32_x64 (1U << 2)
#define CRC32_SSE42_x64 (CRC32_x64|CRC32_SSE42)
#define CRC32_ARM64 (1U << 3)
static uint8_t crc32_alg = CRC32_SW;
#if defined(RTE_ARCH_ARM64) && defined(__ARM_FEATURE_CRC32)
#include "rte_crc_arm64.h"
#elif defined(RTE_ARCH_X86)
#include "rte_crc_x86.h"
#else
#include "rte_crc_generic.h"
#endif
/**
* Allow or disallow use of SSE4.2/ARMv8 intrinsics for CRC32 hash
* calculation.
*
* @param alg
* An OR of following flags:
* - (CRC32_SW) Don't use SSE4.2/ARMv8 intrinsics (default non-[x86/ARMv8])
* - (CRC32_SSE42) Use SSE4.2 intrinsics if available
* - (CRC32_SSE42_x64) Use 64-bit SSE4.2 intrinsic if available (default x86)
* - (CRC32_ARM64) Use ARMv8 CRC intrinsic if available (default ARMv8)
*
*/
static inline void
rte_hash_crc_set_alg(uint8_t alg)
{
crc32_alg = CRC32_SW;
if (alg == CRC32_SW)
return;
#if defined RTE_ARCH_X86
if (!(alg & CRC32_SSE42_x64))
RTE_LOG(WARNING, HASH,
"Unsupported CRC32 algorithm requested using CRC32_x64/CRC32_SSE42\n");
if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_EM64T) || alg == CRC32_SSE42)
crc32_alg = CRC32_SSE42;
else
crc32_alg = CRC32_SSE42_x64;
#endif
#if defined RTE_ARCH_ARM64
if (!(alg & CRC32_ARM64))
RTE_LOG(WARNING, HASH,
"Unsupported CRC32 algorithm requested using CRC32_ARM64\n");
if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_CRC32))
crc32_alg = CRC32_ARM64;
#endif
if (crc32_alg == CRC32_SW)
RTE_LOG(WARNING, HASH,
"Unsupported CRC32 algorithm requested using CRC32_SW\n");
}
/* Setting the best available algorithm */
RTE_INIT(rte_hash_crc_init_alg)
{
#if defined(RTE_ARCH_X86)
rte_hash_crc_set_alg(CRC32_SSE42_x64);
#elif defined(RTE_ARCH_ARM64) && defined(__ARM_FEATURE_CRC32)
rte_hash_crc_set_alg(CRC32_ARM64);
#else
rte_hash_crc_set_alg(CRC32_SW);
#endif
}
#ifdef __DOXYGEN__
/**
* Use single CRC32 instruction to perform a hash on a byte value.
*
* @param data
* Data to perform hash on.
* @param init_val
* Value to initialise hash generator.
* @return
* 32bit calculated hash value.
*/
static inline uint32_t
rte_hash_crc_1byte(uint8_t data, uint32_t init_val);
/**
* Use single CRC32 instruction to perform a hash on a 2 bytes value.
*
* @param data
* Data to perform hash on.
* @param init_val
* Value to initialise hash generator.
* @return
* 32bit calculated hash value.
*/
static inline uint32_t
rte_hash_crc_2byte(uint16_t data, uint32_t init_val);
/**
* Use single CRC32 instruction to perform a hash on a 4 bytes value.
*
* @param data
* Data to perform hash on.
* @param init_val
* Value to initialise hash generator.
* @return
* 32bit calculated hash value.
*/
static inline uint32_t
rte_hash_crc_4byte(uint32_t data, uint32_t init_val);
/**
* Use single CRC32 instruction to perform a hash on a 8 bytes value.
*
* @param data
* Data to perform hash on.
* @param init_val
* Value to initialise hash generator.
* @return
* 32bit calculated hash value.
*/
static inline uint32_t
rte_hash_crc_8byte(uint64_t data, uint32_t init_val);
#endif /* __DOXYGEN__ */
/**
* Calculate CRC32 hash on user-supplied byte array.
*
* @param data
* Data to perform hash on.
* @param data_len
* How many bytes to use to calculate hash value.
* @param init_val
* Value to initialise hash generator.
* @return
* 32bit calculated hash value.
*/
static inline uint32_t
rte_hash_crc(const void *data, uint32_t data_len, uint32_t init_val)
{
unsigned i;
uintptr_t pd = (uintptr_t) data;
for (i = 0; i < data_len / 8; i++) {
init_val = rte_hash_crc_8byte(*(const uint64_t *)pd, init_val);
pd += 8;
}
if (data_len & 0x4) {
init_val = rte_hash_crc_4byte(*(const uint32_t *)pd, init_val);
pd += 4;
}
if (data_len & 0x2) {
init_val = rte_hash_crc_2byte(*(const uint16_t *)pd, init_val);
pd += 2;
}
if (data_len & 0x1)
init_val = rte_hash_crc_1byte(*(const uint8_t *)pd, init_val);
return init_val;
}
#ifdef __cplusplus
}
#endif
#endif /* _RTE_HASH_CRC_H_ */