dpp: C/C++ライブラリをD言語から楽に使う

Programming, D

これは D言語Advent Calendar，16日目の記事です．

はじめに

筆者は常々，D言語の唯一(?)の欠点はコミュニティの小ささ ≒ ライブラリの少なさだと思っていました． しかし実はC/C++とのABI互換性がサポートされており、dppのようなヘッダー生成ツールを使えば，莫大な C/C++ コミュニティのライブラリを全自動で再利用できます． 昨日は同系統の先発ツールdstepが紹介されています． 本記事では後発のdppが非常に大きなライブラリでも実用的に使えるようになったことを紹介します． とくにC/C++から段階的に移行したい読者にとって，D言語を始める良い機会になればと思います．

D言語と C/C++ の互換性

D言語にはCおよびC++(!!)との互換性があるので， extern (C) または extern (C++) で修飾子した型や関数を宣言(bind)して，ビルド済みのC/C++ライブラリをリンクすれば自由に呼び出すことが可能です．

D言語の標準ライブラリ(ランタイム)にある core.stdc と core.stdcpp は，それぞれC/C++標準ライブラリをbindしています．最近では std::vector のような大作も入っています．

ただし，bindを人手で書くので間違えたりするとリンクエラーになったり，巨大なライブラリだと記述量が多くて面倒です (人手で頑張っている deimosや, derelictとその置き換えであるbindbc などのプロジェクトもあります)．

そこで登場したのが dpp です．

https://github.com/atilaneves/dpp

dpp は C/C++ コンパイラのフロントエンド API (libclang) を内部で使うことで，includeしたC/C++ヘッダーから自動的にD言語用の宣言を生成してビルドします．たとえばPythonやJuliaといった巨大なプロジェクトのCヘッダーでさえ，自動でbindできる完成度の高いツールです．

インストール

Debian系のOSなら以下のように環境構築できます．

# libclang のインストール
sudo apt-get install libclang-6.0-dev

# D言語コンパイラのインストール
source $(curl https://dlang.org/install.sh | bash -s -- ldc-1.18.0 -a)

# dpp のビルド
dub fetch dpp --version=0.4.0
dub run dpp -- --help

基本的な使い方

D言語のソースコード中に #include <C/C++ヘッダー名> を記載した dpp ファイルをコンパイルできます．

dub run dpp -- (オプション) ファイル名.dpp

以下のオプションが便利です

  • --compiler dmd や ldc2 などコンパイラを指定
  • --include-path C/C++ライブラリヘッダーのパスを指定
  • --parse-as-cpp includeしたヘッダーをC++の文脈で解釈
  • --keep-d-files 自動で生成したD bindingヘッダーを出力
  • --preprocess-only 上記のヘッダーを出力だけしてコンパイルせず終了

例1: 単一のファイル

D言語はビルドが高速で，短く記述できるのでスクリプトとして単一のファイルを使うことも多いでしょう．

今回は未だBindBCに追加されていないOpenCLを例に，D言語からライブラリ関数を呼んでGPUなどのデバイス情報を表示します． なおOpenCLのインストール方法は利用しているハードウェアベンダのものを推奨します． よくわからないときはpoclなどがaptでインストールできるので便利です．

#include <CL/cl.h>

import std.stdio : writeln;

void main()
{
    // get first platform and device
    cl_platform_id platform;
    cl_device_id device;
    clGetPlatformIDs(1, &platform, null);
    clGetDeviceIDs(platform, CL_DEVICE_TYPE_DEFAULT, 1, &device, null);

    // print device info
    foreach (q; [CL_DEVICE_NAME, CL_DEVICE_VERSION, CL_DRIVER_VERSION])
    {
        cl_ulong len;
        clGetDeviceInfo(device, q, 0, null, &len);
        auto cs = new char[len];
        clGetDeviceInfo(device, q, len, cs.ptr, null);
        writeln(cs);
    }
}

以下を実行すると，ハードウェア情報が表示されるはずです．

$ dub run dpp -- --compiler=ldc2 opencl_test.dpp -L-lOpenCL
$ ./opencl_test
Intel(R) Gen9 HD Graphics NEO
OpenCL 2.1 NEO 
19.26.13286

ちなみにdmdを使うとコンパイラのバグで異常終了します(!?)．

例2: DUB との連携

現状，簡単にDUBと連携する方法はないです．ただしdppは中間のD言語ヘッダーを出力できるので，preBuildCommandsを使って追加設定をするなど連携できます

  • dub.json の preBuildCommands で dpp をインストールし・ヘッダーを自動生成
  • libs にリンクするライブラリを指定
  • (オプション) source 以外の場所に生成した場合 dub.json の sourcePaths importPaths に追加
{
    "preBuildCommands": [
        "dub fetch dpp --version=0.4.0",
        "dub run dpp -- --preprocess-only source/opencl.dpp"
    ],
    "libs": ["OpenCL"],
    "authors": ["karita"],
    "copyright": "Copyright © 2019, karita",
    "description": "dpp demo for OpenCL",
    "license": "BSL-1.0",
    "name": "dpp-opencl"
}

以下のコマンドで私の用意したプロジェクトがビルド出来るはずです．ちなみにこの例では，ベクトルの足し算をGPU上で行う少し長めのコードになっています．

$ git clone https://github.com/ShigekiKarita/dpp-opencl
$ cd dpp-opencl
$ dub run --compiler=ldc2
SUCCESS!!

プロジェクトはGitHubに公開してます、CIスクリプトにpoclのインストールも記載しています。 https://github.com/ShigekiKarita/dpp-opencl

おわりに

私自身は日々 dpp にお世話になっています．たとえば今回紹介した OpenCL だけでなく CUDA のヘッダーなども完璧に動きます．個人的には半年前に OpenCL の SIMD 宣言の翻訳が変というマイナーすぎるバグを報告してみたら，すぐ fix してもらった経験があり，大変感謝しています．

それでは皆さん，快適なD言語生活を!