🦔

CPUの機能を実行時に検出する：x86編

2024/06/23に公開

1件

x86

tech

シリーズ：

CPUの機能を実行時に検出する：x86編（この記事）
CPUの機能を実行時に検出する：Arm編
CPUの機能を実行時に検出する：実践編

その辺で売っているCPUは世代を経るにつれて性能が向上するだけではなく、使える命令が増えていきます。x86系であればSSEが実装され、AVXが実装され、AVX-512が実装され（そして削除され）、という感じです。Armもアーキテクチャーのマイナーバージョンが上がると命令が増えたりします。

新しく追加された命令をプログラムから利用したいとき、直接呼び出してしまうとそのプログラムは古いCPUでは動かなくなってしまいます。コンパイルオプションで切り替えるというのも一つの方法ですが、同じバイナリーを複数のCPUで動かし、最適な性能を得たいという場合に困ります。そこで、実行時にCPUの機能を検出して、プログラム内で分岐するという方法が考えられます。擬似コードで書けば次のようになります：

bool has_AVX2 = ...; // 何らかの方法でAVX2の使用可否を検出する
if (has_AVX2) {
    // AVX2を使った処理を行う
} else {
    // AVX2を使わずに処理を行う
}

x86系の場合、実行時にCPUの機能を検出するには cpuid 命令を使います。しかし、cpuid 命令を使うには特定のレジスターを読み書きする必要があり、C言語のような高級言語からアクセスするにはコンパイラー依存のテクニックが必要です。ここでは、コンパイラーごとに cpuid 命令を使う方法を紹介します。

cpuid は問い合わせる機能のジャンルを表す2つの整数（leafとかfunctionとか呼ばれる）を受け取り、4つの整数を返す関数と解釈することができます。擬似コードで書けばこんな感じです：

function cpuid(leaf: u32, subleaf: u32) -> (eax: u32, ebx: u32, ecx: u32, edx: u32)

1番目の引数次第で、2番目の引数は無視されます。そのため、引数を1つしか取らない組み込み関数が用意されている場合もあります。

例えば、AVXの有無は次のように確認できます：

(_, _, c, _) = cpuid(0x01, 0); // subleafは無視される
avx: bool = (c & (1 << 28)) != 0;
(_, b, _, _) = cpuid(0x07, 0);
avx2: bool = (b & (1 << 5)) != 0;
avx512f: bool = (b & (1 << 16)) != 0;

【追記】CPUがAVXに対応していても、OSがYMMレジスター等に対応していない可能性があるので、本当にAVXを使いたい場合はこの擬似コードでは不十分です。ちゃんとしたやり方はIntel SDM等を参照するか、あるいはいい感じにラップしてくれるライブラリー（後述する「GCC/Clangの組み込み関数」を含む）を使ってください。【/追記】

cpuid 命令の詳細はIntel SDMやAMD APM（AMD特有の命令については当然Intel SDMには載っていないのでAMDのマニュアルを見る必要があります）を見てもらうことにして、ここでは各コンパイラーからの cpuid の使い方を見ます。

`<cpuid.h>` を使う

GCCやClangは <cpuid.h> を用意しており、cpuid 命令のラッパーである __cpuid マクロ、__cpuid_count マクロ、__get_cpuid_max 関数、__get_cpuid 関数、__get_cpuid_count 関数、そして各種機能に対応する定数が利用できます。

#include <cpuid.h>
void __cpuid(unsigned int leaf, [out] unsigned int eax, [out] unsigned int ebx, [out] unsigned int ecx, [out] unsigned int edx); // マクロ
void __cpuid_count(unsigned int leaf, unsigned int count, [out] unsigned int eax, [out] unsigned int ebx, [out] unsigned int ecx, [out] unsigned int edx); // マクロ
unsigned int __get_cpuid_max(unsigned int leaf, unsigned int *sig);
int __get_cpuid(unsigned int leaf, unsigned int *eax, unsigned int *ebx, unsigned int *ecx, unsigned int *edx);
int __get_cpuid_count(unsigned int leaf, unsigned int subleaf, unsigned int *eax, unsigned int *ebx, unsigned int *ecx, unsigned int *edx);

__get_ から始まる方は cpuid 命令を呼び出す際にleafが範囲内かチェックしてくれるようです。

使用例は次のようになります。

#include <cpuid.h>
#include <stdio.h>

int main(void)
{
    unsigned int eax, ebx, ecx, edx;
    __cpuid(0x01, eax, ebx, ecx, edx);
    printf("AVX: %d\n", (ecx & bit_AVX) != 0);
    __cpuid_count(0x07, 0, eax, ebx, ecx, edx);
    printf("AVX2: %d\n", (ebx & bit_AVX2) != 0);
    printf("AVX-512F: %d\n", (ebx & bit_AVX512F) != 0);
}

【追記】本当にAVXを使えるか確かめたい場合はこのコードでは不十分です。先述の注意を参照してください。【/追記】

実行例：

AVX: 1
AVX2: 1
AVX-512F: 1

GCC/Clangの組み込み関数を使う

GCC/Clangは cpuid をラップした組み込み関数を提供しています。

void __builtin_cpu_init(void);
int __builtin_cpu_is(const char *cpuname);
int __builtin_cpu_supports(const char *feature);

__builtin_cpu_supports に機能の名前を文字列で渡すと判定できます。

__builtin_cpu_init は main 関数の前に __builtin_cpu_supports を使う場合に呼び出す必要があります。main 関数以降ならわざわざ呼び出す必要はありません。

使用例：

#include <stdio.h>

int main(void)
{
    printf("AVX: %d\n", !!__builtin_cpu_supports("avx"));
    printf("AVX2: %d\n", !!__builtin_cpu_supports("avx2"));
    printf("AVX-512F: %d\n", !!__builtin_cpu_supports("avx512f"));
}

MSVCの組み込み関数を使う

MSVCも組み込み関数を提供しています。<cpuid.h> のマクロと名前が同じですが引数が違うので注意してください。

__cpuid, __cpuidex | Microsoft Learn

void __cpuid(int cpuInfo[4], int function_id);
void __cpuidex(int cpuInfo[4], int function_id, int subfunction_id);

使用例：

#include <stdio.h>

int main(void)
{
    int result[4]; // {eax, ebx, ecx, edx}
    __cpuid(result, 0x01);
    printf("AVX: %d\n", (result[2] & (1 << 28)) != 0);
    __cpuidex(result, 0x07, 0);
    printf("AVX2: %d\n", (result[1] & (1 << 5)) != 0);
    printf("AVX-512F: %d\n", (result[1] & (1 << 16)) != 0);
}

【追記】本当にAVXを使えるか確かめたい場合はこのコードでは不十分です。先述の注意を参照してください。【/追記】

Intelの組み込み関数を使う

みんな大好きIntel Intrinsics Guideに cpuid 用の組み込み関数は載っているでしょうか？実はあります。

Intel® Intrinsics Guide

#include <immintrin.h>
int _may_i_use_cpu_feature(unsigned __int64 a);
int _may_i_use_cpu_feature_ext(unsigned __int64 a, unsigned page);
int _may_i_use_cpu_feature_str(string literal feature, ...);

まあ、私が今試した感じではGCC/Clang/MSVCはこれに対応していないようなので、IntelのCコンパイラー専用という感じでしょうか。

使用例：

#include <immintrin.h>
#include <stdio.h>

int main(void)
{
    printf("AVX: %d\n", !!_may_i_use_cpu_feature(_FEATURE_AVX));
    printf("AVX2: %d\n", !!_may_i_use_cpu_feature(_FEATURE_AVX2));
    printf("AVX-512F: %d\n", !!_may_i_use_cpu_feature(_FEATURE_AVX512F));
}

#include <immintrin.h>
#include <stdio.h>

int main(void)
{
    printf("AVX: %d\n", !!_may_i_use_cpu_feature_str("avx"));
    printf("AVX2: %d\n", !!_may_i_use_cpu_feature_str("avx2"));
    printf("AVX-512F: %d\n", !!_may_i_use_cpu_feature_str("avx512f"));
}

【追記】Intelの組み込み関数が「OSがYMM等に対応しているか」を考慮してくれるかは調べていないのでよくわかりません。本気でこれでAVXの使用可否をテストしたい場合はその辺も確認すると良いでしょう。【/追記】

インラインアセンブリを使う

GCCやClangではインラインアセンブリで cpuid 命令を呼び出すこともできます。

#include <stdio.h>

int main(void) {
    unsigned int eax, ebx, ecx, edx;
    asm volatile("cpuid" : "=a"(eax), "=b"(ebx), "=c"(ecx), "=d"(edx) : "0"(0x01), "2"(0));
    printf("AVX: %d\n", (ecx & (1 << 28)) != 0);
    asm volatile("cpuid" : "=a"(eax), "=b"(ebx), "=c"(ecx), "=d"(edx) : "0"(0x07), "2"(0));
    printf("AVX2: %d\n", (ebx & (1 << 5)) != 0);
    printf("AVX-512F: %d\n", (ebx & (1 << 16)) != 0);
}

【追記】本当にAVXを使えるか確かめたい場合はこのコードでは不十分です。先述の注意を参照してください。【/追記】

なお、x86_64では rbx がcallee-savedなレジスターであるため、Clangの <cpuid.h> では cpuid の呼び出し前後に rbx の退避を行なっているようですが、私が試した感じではGCC/Clangは自前で退避しなくても関数のプロローグとエピローグで rbx を退避するコードを出力するようでした。私の知らない事情が絡んでいる可能性はありますが……。

macOSでAVX-512を検出するときの注意点

Intel SDMによると、AVX-512の使用可否を検出するには、CPUIDのビットの他に、XCR0をチェックしてOSがAVX-512の状態を有効にしているか確認する必要があります。しかし、この方法ではmacOSにおいてAVX-512が使えるマシンでも「AVX-512が使えない」と判定してしまいます。

こうなる理由はこの辺を参照してください：

https://github.com/apple/darwin-xnu/blob/2ff845c2e033bd0ff64b5b6aa6063a1f8f65aa32/osfmk/i386/fpu.c#L174

大雑把に言うと、AVX-512を使わないプログラムでAVX-512の状態を保存しなくて良いようにするためのようです。XCR0による「AVX-512が使えない」という判断はある意味正しく、プログラムがAVX-512を使おうとすると例外が発生しますが、カーネルがその例外を捕捉してそのプログラムについてAVX-512の状態を有効化してくれる、という寸法です。

とにかく、macOSでAVX-512を検出するのは通常の cpuid ではできないので、OS固有の方法を使う必要があります。具体的には、sysctl を使います。CPUの機能を実行時に検出する：Arm編も見てください。

コード例は次のようになります：

#include <stdbool.h>
#include <stdio.h>
#include <sys/sysctl.h>

bool query_cpu_feature(const char *name)
{
    int result = 0;
    size_t len = sizeof(result);
    int ok = sysctlbyname(name, &result, &len, NULL, 0);
    // 成功時には 0 が返る
    return ok == 0 && result != 0;
}

int main(void)
{
    printf("AVX512F: %d\n", (int)query_cpu_feature("hw.optional.avx512f"));
    printf("AVX512CD: %d\n", (int)query_cpu_feature("hw.optional.avx512cd"));
    printf("AVX512DQ: %d\n", (int)query_cpu_feature("hw.optional.avx512dq"));
    printf("AVX512BW: %d\n", (int)query_cpu_feature("hw.optional.avx512bw"));
    printf("AVX512VL: %d\n", (int)query_cpu_feature("hw.optional.avx512vl"));
    printf("AVX512IFMA: %d\n", (int)query_cpu_feature("hw.optional.avx512ifma"));
    printf("AVX512VBMI: %d\n", (int)query_cpu_feature("hw.optional.avx512vbmi"));
}

出力例：

AVX512F: 1
AVX512CD: 1
AVX512DQ: 1
AVX512BW: 1
AVX512VL: 1
AVX512IFMA: 1
AVX512VBMI: 1

まあAVX512Fだけ sysctl でチェックして、残りは通常の cpuid で判定するので良いでしょう。

Discussion

herumi

昔のMacのコンパイラでは退避しないとエラーになっていたので、その名残で明示的に退避してるのかもしれません。
https://bugs.php.net/bug.php?id=76654

<cpuid.h> を使う

GCC/Clangの組み込み関数を使う

MSVCの組み込み関数を使う

Intelの組み込み関数を使う

インラインアセンブリを使う

macOSでAVX-512を検出するときの注意点

Discussion

`<cpuid.h>` を使う