Zenn
🧮

多倍長整数の実装2（Xbyak）

2022/05/23に公開
C++
int
add
xbyak
tech

初めに

前回、多倍長整数の実装1（C/C++）では固定長256bit整数加算をC++で実装しました。
今回はXbyakを用いて実装します。
記事全体の一覧は多倍長整数の実装1（C/C++）参照。

x64レジスタ

まず、多倍長整数の加算に必要な最低限のx64アセンブリ言語（以下asm）を説明します。

64bitの汎用レジスタと呼ばれる変数がrax, rbx, rcx, rdx, rsi, rdi, rbpとr8からr15までの15個あります。
64bitの下位32bitはeax, ebx, ecx, edx, esi, edi, ebp, r8d, r9d, ..., r15dで操作できます。
C/C++の関数内で利用する一次変数や関数の戻る場所などを記憶するためのスタック領域を指すレジスタがrspです。

関数の引数は1番目から順にWindowsならrcx, rdx, r8, r9, Linuxならrdi, rsi, rdx, rcxです。関数の戻り値はraxを利用します。
詳細はWindowsでの呼び出し既約を参照ください。

いくつかの命令を紹介します。下記のaやbはレジスタを表します。

  • mov a, [b] : bで指すアドレスの値をaに読み込む。
  • mov [b], a : aをbで指すアドレスに書き込む。
  • add a, b : Cのa += bを表す。
  • sub a, b : Cのa -= bを表す。

キャリーフラグ

x86/x64ではadd命令の実行結果がレジスタサイズを越えない or 超えたに応じてCF（Carry Flag）という特殊なレジスタが0 or 1になります。
そしてCFを考慮した加算命令adcがあります。

adc a, bはa += b + CFを意味します。
adcの演算結果に応じてCFも更新されます。

これを使うとa, b, c, dが64bitレジスタで[a:b]と[c:d]という2個の128bit整数の加算[a:b] += [c:d]は

add b, d : b += d
adc a, c : a += c + CF

で表現できます。

Xbyak

準備ができたところでXbyakを使ってみましょう。
Xbyakはx86/x64のアセンブリ言語を記述できるC++のライブラリです。
ヘッダファイルをコピーしてincludeパスを指定すれば使えます。

N桁のUnit同士の加算コードは次のように記述できます。

#include <xbyak/xbyak_util.h>

struct Code : Xbyak::CodeGenerator {
  Code(int N)
  {
    Xbyak::util::StackFrame sf(this, 3);
    const auto& z = sf.p[0];
    const auto& x = sf.p[1];
    const auto& y = sf.p[2];
    for (int i = 0; i < N; i++) {
      mov(rax, ptr[x + 8 * i]);
      if (i == 0) {
        add(rax, ptr[y + 8 * i]);
      } else {
        adc(rax, ptr[y + 8 * i]);
      }
      mov(ptr[z + 8 * i], rax);
    }
    setc(al);
    movzx(eax, al);
  }
};

以下説明

  • Xbyak::CodeGeneratorクラスを継承するとその中で、クラスメソッドとしてasmの命令を関数呼び出しとして記述できます。
    • asmでadd rax, rcxはadd(rax, rcx), mov rax, [rsp]はmov(rax, ptr[rsp])となります。
    • 詳細はXbyakのマニュアルを参照ください。
  • Xbyak::util::StackFrameはWindowsとLinuxの関数の引数の違いを吸収する簡易クラスです。
    • 1番目にそのクラスのthis, 2番目に今から作る関数の引数の個数を指定します。
    • sf.p[0], sf.p[1]が1番目, 2番目の汎用レジスタを表します。
    • ここではadd(Unit *z, const Unit *x, const Unit *y)という関数を作りたいので、それぞれをz, x, yという名前にしています。
  • 前節で述べたように最初はadd, 2番目以降はadcを使うとCFを伝搬させつつ加算を実装できます。
    • 64bitの場合オフセットは8byteずつ増えるのでx + 8 * iという形になっています。
    • raxは自由に使ってよいレジスタです。
    • mov(ptr[z + 8 * i], rax)で演算結果をz[i]に保存しています。
  • setc(al)はal = CFという意味です。
    • movzx(eax, al)は8bitのalの値を32bitのeaxにゼロ拡張(Zero eXtended)します。
    • 64bit環境でeaxを更新するとraxの上位32bitはクリアされます。結果的にalの値をraxにゼロ拡張します。
  • StackFrameクラスはそのライフスコープを抜けるとき後始末をします。ここでは呼出元に戻るret()が挿入されます。

生成コード

Code code(4);
auto add4 = code.getCode<uint64_t (*)(uint64_t *, const uint64_t *, const uint64_t *)>();

とすると4桁（256bit）の加算関数が生成されて、その関数ポインタがadd4となります。
生成されたコードサイズはcode.getSize()で取得できます。

生成されたコードをcodeというファイルに保存して逆アセンブルしてみましょう。

int main()
{
  Code code(4);
  auto add4 = code.getCode<uint64_t (*)(uint64_t *, const uint64_t *, const uint64_t *)>();
  std::ofstream ofs("code", std::ios::binary);
  ofs.write((const char*)add4, code.getSize());
}

Windows環境でIntel Software Development Emulatorのxedを使ってみます。

xed -64 -ir code

mov rax, qword ptr [rdx]
add rax, qword ptr [r8]
mov qword ptr [rcx], rax
mov rax, qword ptr [rdx+0x8]
adc rax, qword ptr [r8+0x8]
mov qword ptr [rcx+0x8], rax
mov rax, qword ptr [rdx+0x10]
adc rax, qword ptr [r8+0x10]
mov qword ptr [rcx+0x10], rax
mov rax, qword ptr [rdx+0x18]
adc rax, qword ptr [r8+0x18]
mov qword ptr [rcx+0x18], rax
setb al
movzx eax, al

Linux環境ではobjdumpを使ってみますか。

objdump -D -b binary -m i386 -M x86-64,intel code
mov    rax,QWORD PTR [rsi]
add    rax,QWORD PTR [rdx]
mov    QWORD PTR [rdi],rax
mov    rax,QWORD PTR [rsi+0x8]
adc    rax,QWORD PTR [rdx+0x8]
mov    QWORD PTR [rdi+0x8],rax
mov    rax,QWORD PTR [rsi+0x10]
adc    rax,QWORD PTR [rdx+0x10]
mov    QWORD PTR [rdi+0x10],rax
mov    rax,QWORD PTR [rsi+0x18]
adc    rax,QWORD PTR [rdx+0x18]
mov    QWORD PTR [rdi+0x18],rax
setb   al
movzx  eax,al
ret

qword ptrはXbyakのptrに相当します（Xbyakでもqwordと記述できます）。
簡潔で最小限のコードになっていることが分かります。
これと比べると前回のC++による実装結果はかなり無駄な操作があることが分かります。

GitHubで編集を提案

Discussion