portability_macros.h File Reference

Go to the source code of this file.

Macros
#define	__has_attribute(x)
#define	__has_builtin(x)
#define	__has_feature(x)
#define	ZSTD_MEMORY_SANITIZER   0
#define	ZSTD_ADDRESS_SANITIZER   0
#define	ZSTD_DATAFLOW_SANITIZER   0
#define	ZSTD_HIDE_ASM_FUNCTION(func)
#define	DYNAMIC_BMI2   0
#define	ZSTD_ASM_SUPPORTED   0
#define	ZSTD_ENABLE_ASM_X86_64_BMI2   0

Macro Definition Documentation

__has_attribute

#define __has_attribute

(

x

)

Value:

0

This header file contains macro defintions to support portability. This header is shared between C and ASM code, so it MUST only contain macro definitions. It MUST not contain any C code.

This header ONLY defines macros to detect platforms/feature support.

__has_builtin

#define __has_builtin

(

x

)

Value:

0

__has_feature

#define __has_feature

(

x

)

Value:

0

DYNAMIC_BMI2

#define DYNAMIC_BMI2   0

ZSTD_ADDRESS_SANITIZER

#define ZSTD_ADDRESS_SANITIZER   0

ZSTD_ASM_SUPPORTED

#define ZSTD_ASM_SUPPORTED   0

Only enable assembly for GNUC comptabile compilers, because other platforms may not support GAS assembly syntax.

Only enable assembly for Linux / MacOS, other platforms may work, but they haven't been tested. This could likely be extended to BSD systems.

Disable assembly when MSAN is enabled, because MSAN requires 100% of code to be instrumented to work.

ZSTD_DATAFLOW_SANITIZER

#define ZSTD_DATAFLOW_SANITIZER   0

ZSTD_ENABLE_ASM_X86_64_BMI2

#define ZSTD_ENABLE_ASM_X86_64_BMI2   0

Determines whether we should enable assembly for x86-64 with BMI2.

Enable if all of the following conditions hold:

• ASM hasn't been explicitly disabled by defining ZSTD_DISABLE_ASM
• Assembly is supported
• We are compiling for x86-64 and either:
  • DYNAMIC_BMI2 is enabled
  • BMI2 is supported at compile time

ZSTD_HIDE_ASM_FUNCTION

#define ZSTD_HIDE_ASM_FUNCTION

(

func

)

ZSTD_MEMORY_SANITIZER

#define ZSTD_MEMORY_SANITIZER   0