liblzma: Rename arch-specific CRC functions and macros.

CRC_CLMUL was split to CRC_ARCH_OPTIMIZED and CRC_X86_CLMUL.
CRC_ARCH_OPTIMIZED is defined when an arch-optimized version is used.
Currently the x86 CLMUL implementations are the only arch-optimized
versions, and these also use the CRC_x86_CLMUL macro to tell when
crc_x86_clmul.h needs to be included.

is_clmul_supported() was renamed to is_arch_extension_supported().
crc32_clmul() and crc64_clmul() were renamed to
crc32_arch_optimized() and crc64_arch_optimized().
This way the names make sense with arch-specific non-CLMUL
implementations as well.
This commit is contained in:
Lasse Collin 2024-01-10 18:23:31 +02:00
parent 3dbed75b0b
commit 66f080e801
4 changed files with 31 additions and 25 deletions

View File

@ -15,7 +15,7 @@
#include "check.h" #include "check.h"
#include "crc_common.h" #include "crc_common.h"
#ifdef CRC_CLMUL #ifdef CRC_X86_CLMUL
# define BUILDING_CRC32_CLMUL # define BUILDING_CRC32_CLMUL
# include "crc_x86_clmul.h" # include "crc_x86_clmul.h"
#endif #endif
@ -87,7 +87,7 @@ crc32_generic(const uint8_t *buf, size_t size, uint32_t crc)
#endif #endif
#if defined(CRC_GENERIC) && defined(CRC_CLMUL) #if defined(CRC_GENERIC) && defined(CRC_ARCH_OPTIMIZED)
////////////////////////// //////////////////////////
// Function dispatching // // Function dispatching //
@ -137,7 +137,8 @@ typedef uint32_t (*crc32_func_type)(
static crc32_func_type static crc32_func_type
crc32_resolve(void) crc32_resolve(void)
{ {
return is_clmul_supported() ? &crc32_clmul : &crc32_generic; return is_arch_extension_supported()
? &crc32_arch_optimized : &crc32_generic;
} }
#if defined(HAVE_FUNC_ATTRIBUTE_IFUNC) && defined(__clang__) #if defined(HAVE_FUNC_ATTRIBUTE_IFUNC) && defined(__clang__)
@ -193,7 +194,7 @@ lzma_crc32(const uint8_t *buf, size_t size, uint32_t crc)
extern LZMA_API(uint32_t) extern LZMA_API(uint32_t)
lzma_crc32(const uint8_t *buf, size_t size, uint32_t crc) lzma_crc32(const uint8_t *buf, size_t size, uint32_t crc)
{ {
#if defined(CRC_GENERIC) && defined(CRC_CLMUL) #if defined(CRC_GENERIC) && defined(CRC_ARCH_OPTIMIZED)
// If CLMUL is available, it is the best for non-tiny inputs, // If CLMUL is available, it is the best for non-tiny inputs,
// being over twice as fast as the generic slice-by-four version. // being over twice as fast as the generic slice-by-four version.
// However, for size <= 16 it's different. In the extreme case // However, for size <= 16 it's different. In the extreme case
@ -225,8 +226,8 @@ lzma_crc32(const uint8_t *buf, size_t size, uint32_t crc)
*/ */
return crc32_func(buf, size, crc); return crc32_func(buf, size, crc);
#elif defined(CRC_CLMUL) #elif defined(CRC_ARCH_OPTIMIZED)
return crc32_clmul(buf, size, crc); return crc32_arch_optimized(buf, size, crc);
#else #else
return crc32_generic(buf, size, crc); return crc32_generic(buf, size, crc);

View File

@ -14,7 +14,7 @@
#include "check.h" #include "check.h"
#include "crc_common.h" #include "crc_common.h"
#ifdef CRC_CLMUL #ifdef CRC_X86_CLMUL
# define BUILDING_CRC64_CLMUL # define BUILDING_CRC64_CLMUL
# include "crc_x86_clmul.h" # include "crc_x86_clmul.h"
#endif #endif
@ -82,7 +82,7 @@ crc64_generic(const uint8_t *buf, size_t size, uint64_t crc)
#endif #endif
#if defined(CRC_GENERIC) && defined(CRC_CLMUL) #if defined(CRC_GENERIC) && defined(CRC_ARCH_OPTIMIZED)
////////////////////////// //////////////////////////
// Function dispatching // // Function dispatching //
@ -102,7 +102,8 @@ typedef uint64_t (*crc64_func_type)(
static crc64_func_type static crc64_func_type
crc64_resolve(void) crc64_resolve(void)
{ {
return is_clmul_supported() ? &crc64_clmul : &crc64_generic; return is_arch_extension_supported()
? &crc64_arch_optimized : &crc64_generic;
} }
#if defined(HAVE_FUNC_ATTRIBUTE_IFUNC) && defined(__clang__) #if defined(HAVE_FUNC_ATTRIBUTE_IFUNC) && defined(__clang__)
@ -150,7 +151,7 @@ lzma_crc64(const uint8_t *buf, size_t size, uint64_t crc)
extern LZMA_API(uint64_t) extern LZMA_API(uint64_t)
lzma_crc64(const uint8_t *buf, size_t size, uint64_t crc) lzma_crc64(const uint8_t *buf, size_t size, uint64_t crc)
{ {
#if defined(CRC_GENERIC) && defined(CRC_CLMUL) #if defined(CRC_GENERIC) && defined(CRC_ARCH_OPTIMIZED)
#ifdef CRC_USE_GENERIC_FOR_SMALL_INPUTS #ifdef CRC_USE_GENERIC_FOR_SMALL_INPUTS
if (size <= 16) if (size <= 16)
@ -158,14 +159,14 @@ lzma_crc64(const uint8_t *buf, size_t size, uint64_t crc)
#endif #endif
return crc64_func(buf, size, crc); return crc64_func(buf, size, crc);
#elif defined(CRC_CLMUL) #elif defined(CRC_ARCH_OPTIMIZED)
// If CLMUL is used unconditionally without runtime CPU detection // If CLMUL is used unconditionally without runtime CPU detection
// then omitting the generic version and its 8 KiB lookup table // then omitting the generic version and its 8 KiB lookup table
// makes the library smaller. // makes the library smaller.
// //
// FIXME: Lookup table isn't currently omitted on 32-bit x86, // FIXME: Lookup table isn't currently omitted on 32-bit x86,
// see crc64_table.c. // see crc64_table.c.
return crc64_clmul(buf, size, crc); return crc64_arch_optimized(buf, size, crc);
#else #else
return crc64_generic(buf, size, crc); return crc64_generic(buf, size, crc);

View File

@ -70,7 +70,8 @@
#endif #endif
#undef CRC_GENERIC #undef CRC_GENERIC
#undef CRC_CLMUL #undef CRC_ARCH_OPTIMIZED
#undef CRC_X86_CLMUL
#undef CRC_USE_IFUNC #undef CRC_USE_IFUNC
#undef CRC_USE_GENERIC_FOR_SMALL_INPUTS #undef CRC_USE_GENERIC_FOR_SMALL_INPUTS
@ -86,12 +87,14 @@
// NOTE: Keep this this in sync with crc32_table.c. // NOTE: Keep this this in sync with crc32_table.c.
#elif (defined(__SSSE3__) && defined(__SSE4_1__) && defined(__PCLMUL__)) \ #elif (defined(__SSSE3__) && defined(__SSE4_1__) && defined(__PCLMUL__)) \
|| (defined(__e2k__) && __iset__ >= 6) || (defined(__e2k__) && __iset__ >= 6)
# define CRC_CLMUL 1 # define CRC_ARCH_OPTIMIZED 1
# define CRC_X86_CLMUL 1
// Otherwise build both and detect at runtime which version to use. // Otherwise build both and detect at runtime which version to use.
#else #else
# define CRC_GENERIC 1 # define CRC_GENERIC 1
# define CRC_CLMUL 1 # define CRC_ARCH_OPTIMIZED 1
# define CRC_X86_CLMUL 1
# ifdef HAVE_FUNC_ATTRIBUTE_IFUNC # ifdef HAVE_FUNC_ATTRIBUTE_IFUNC
# define CRC_USE_IFUNC 1 # define CRC_USE_IFUNC 1

View File

@ -3,7 +3,7 @@
/// \file crc_x86_clmul.h /// \file crc_x86_clmul.h
/// \brief CRC32 and CRC64 implementations using CLMUL instructions. /// \brief CRC32 and CRC64 implementations using CLMUL instructions.
/// ///
/// crc32_clmul() and crc64_clmul() use 32/64-bit x86 SSSE3, SSE4.1, and /// The CRC32 and CRC64 implementations use 32/64-bit x86 SSSE3, SSE4.1, and
/// CLMUL instructions. This is compatible with Elbrus 2000 (E2K) too. /// CLMUL instructions. This is compatible with Elbrus 2000 (E2K) too.
/// ///
/// They were derived from /// They were derived from
@ -212,7 +212,7 @@ crc_simd_body(const uint8_t *buf, const size_t size, __m128i *v0, __m128i *v1,
/* /*
// These functions were used to generate the constants // These functions were used to generate the constants
// at the top of lzma_crc32_clmul(). // at the top of crc32_arch_optimized().
static uint64_t static uint64_t
calc_lo(uint64_t p, uint64_t a, int n) calc_lo(uint64_t p, uint64_t a, int n)
{ {
@ -240,7 +240,7 @@ calc_hi(uint64_t p, uint64_t a, int n)
crc_attr_target crc_attr_target
crc_attr_no_sanitize_address crc_attr_no_sanitize_address
static uint32_t static uint32_t
crc32_clmul(const uint8_t *buf, size_t size, uint32_t crc) crc32_arch_optimized(const uint8_t *buf, size_t size, uint32_t crc)
{ {
#ifndef CRC_USE_GENERIC_FOR_SMALL_INPUTS #ifndef CRC_USE_GENERIC_FOR_SMALL_INPUTS
// The code assumes that there is at least one byte of input. // The code assumes that there is at least one byte of input.
@ -284,7 +284,7 @@ crc32_clmul(const uint8_t *buf, size_t size, uint32_t crc)
/* /*
// These functions were used to generate the constants // These functions were used to generate the constants
// at the top of lzma_crc64_clmul(). // at the top of crc64_arch_optimized().
static uint64_t static uint64_t
calc_lo(uint64_t poly) calc_lo(uint64_t poly)
{ {
@ -319,8 +319,9 @@ calc_hi(uint64_t poly, uint64_t a)
// and CRC32 CLMUL aren't affected by this problem. The problem does not // and CRC32 CLMUL aren't affected by this problem. The problem does not
// happen in crc_simd_body() either (which is shared with CRC32 CLMUL anyway). // happen in crc_simd_body() either (which is shared with CRC32 CLMUL anyway).
// //
// NOTE: Another pragma after lzma_crc64_clmul() restores the optimizations. // NOTE: Another pragma after crc64_arch_optimized() restores
// If the #if condition here is updated, the other one must be updated too. // the optimizations. If the #if condition here is updated,
// the other one must be updated too.
#if defined(_MSC_VER) && !defined(__INTEL_COMPILER) && !defined(__clang__) \ #if defined(_MSC_VER) && !defined(__INTEL_COMPILER) && !defined(__clang__) \
&& defined(_M_IX86) && defined(_M_IX86)
# pragma optimize("g", off) # pragma optimize("g", off)
@ -329,7 +330,7 @@ calc_hi(uint64_t poly, uint64_t a)
crc_attr_target crc_attr_target
crc_attr_no_sanitize_address crc_attr_no_sanitize_address
static uint64_t static uint64_t
crc64_clmul(const uint8_t *buf, size_t size, uint64_t crc) crc64_arch_optimized(const uint8_t *buf, size_t size, uint64_t crc)
{ {
#ifndef CRC_USE_GENERIC_FOR_SMALL_INPUTS #ifndef CRC_USE_GENERIC_FOR_SMALL_INPUTS
// The code assumes that there is at least one byte of input. // The code assumes that there is at least one byte of input.
@ -379,8 +380,8 @@ crc64_clmul(const uint8_t *buf, size_t size, uint64_t crc)
#endif // BUILDING_CRC64_CLMUL #endif // BUILDING_CRC64_CLMUL
// is_clmul_supported() must be inlined in this header file because the // is_arch_extension_supported() must be inlined in this header file because
// ifunc resolver function may not support calling a function in another // the ifunc resolver function may not support calling a function in another
// translation unit. Depending on compiler-toolchain and flags, a call to // translation unit. Depending on compiler-toolchain and flags, a call to
// a function defined in another translation unit could result in a // a function defined in another translation unit could result in a
// reference to the PLT, which is unsafe to do in an ifunc resolver. The // reference to the PLT, which is unsafe to do in an ifunc resolver. The
@ -389,7 +390,7 @@ crc64_clmul(const uint8_t *buf, size_t size, uint64_t crc)
// the function body in crc32_resolve() and crc64_resolve(), but this is // the function body in crc32_resolve() and crc64_resolve(), but this is
// acceptable because the function results in very few instructions. // acceptable because the function results in very few instructions.
static inline bool static inline bool
is_clmul_supported(void) is_arch_extension_supported(void)
{ {
int success = 1; int success = 1;
uint32_t r[4]; // eax, ebx, ecx, edx uint32_t r[4]; // eax, ebx, ecx, edx