cpu_features
A cross-platform C library to retrieve CPU features (such as available
instructions) at runtime.
GitHub-CI Status
|
Linux |
MacOS |
Windows |
| amd64 |
|
|
|
| AArch64 |
|
|
|
| ARM |
|
|
|
| MIPS |
|
|
|
| POWER |
|
|
|
| RISCV |
|
|
|
| s390x |
|
|
|
Table of Contents
Design Rationale
- Simple to use. See the snippets below for examples.
- Extensible. Easy to add missing features or architectures.
- Compatible with old compilers and available on many architectures so it
can be used widely. To ensure that cpu_features works on as many platforms
as possible, we implemented it in a highly portable version of C: C99.
- Sandbox-compatible. The library uses a variety of strategies to cope
with sandboxed environments or when
cpuid is unavailable. This is useful
when running integration tests in hermetic environments.
- Thread safe, no memory allocation, and raises no exceptions.
cpu_features is suitable for implementing fundamental libc functions like
malloc, memcpy, and memcmp.
- Unit tested.
Code samples
Note: For C++ code, the library functions are defined in the cpu_features namespace.
Checking features at runtime
Here's a simple example that executes a codepath if the CPU supports both the
AES and the SSE4.2 instruction sets:
#include "cpuinfo_x86.h"
// For C++, add `using namespace cpu_features;`
static const X86Features features = GetX86Info().features;
void Compute(void) {
if (features.aes && features.sse4_2) {
// Run optimized code.
} else {
// Run standard code.
}
}
Caching for faster evaluation of complex checks
If you wish, you can read all the features at once into a global variable, and
then query for the specific features you care about. Below, we store all the ARM
features and then check whether AES and NEON are supported.
#include <stdbool.h>
#include "cpuinfo_arm.h"
// For C++, add `using namespace cpu_features;`
static const ArmFeatures features = GetArmInfo().features;
static const bool has_aes_and_neon = features.aes && features.neon;
// use has_aes_and_neon.
This is a good approach to take if you're checking for combinations of features
when using a compiler that is slow to extract individual bits from bit-packed
structures.
Checking compile time flags
The following code determines whether the compiler was told to use the AVX
instruction set (e.g., g++ -mavx) and sets has_avx accordingly.
#include <stdbool.h>
#include "cpuinfo_x86.h"
// For C++, add `using namespace cpu_features;`
static const X86Features features = GetX86Info().features;
static const bool has_avx = CPU_FEATURES_COMPILED_X86_AVX || features.avx;
// use has_avx.
CPU_FEATURES_COMPILED_X86_AVX is set to 1 if the compiler was instructed to
use AVX and 0 otherwise, combining compile time and runtime knowledge.
Rejecting poor hardware implementations based on microarchitecture