RustからC/C++を使う

目的

C/C++で書かれているコードをRustから使用するにはどうすればよいかを知る。

方法① CのコードをRustと一緒にビルドする方法

cc-rsを使った方法
The Crgo Bookに記載してある方法で実行できた。

流れ
①構成を以下のようにする

②ccクレートを使うことをtomlファイルに記述。CファイルにHello World実装
ccクレートを使うことでcargoにリンクオプションを自動追加してくれ、Ｃコードから生成されたlib.aファイルを自動でリンクしてくれるようになる。

Cargo.toml

[package]
name = "tmp"
version = "0.1.0"
edition = "2018"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[build-dependencies]
cc = "1.0"

hello.c

# include <stdio.h>

void hello() {
    printf("Hello, World!\n");
}

main.rs

extern { fn hello(); }

fn main() {
    unsafe { hello(); }
}

②build.rsファイルにどのＣファイルをビルドするか記述する

Build.rs

extern crate cc;

fn main() {
    cc::Build::new()
        .file("src/hello.c")
        .compile("hello");
    println!("cargo:rerun-if-changed=src/hello.c");
}

③ビルド実行
ビルドを実行すると、outフォルダにhello.cから作成されたlibhello.aファイルが作成され自動でリンクしてくれる。

Hello Worldが表示される

詰まった箇所としてはcc-rsはclang MSVCで実行されるようで、vsCodeのビルドのデフォルトをgccにしていると上手くいかなかった。clangが必要。

方法② CのAPIを、Rustで使えるようにインターフェース定義する方法

bindgenを使い、自動でインターフェースが生成することができる。
RustでCのどの機能を使っているか分かりやすい。

①フォルダ構成

src下

②Rustで使いたいインターフェースやデータ型定義を全てのCヘッダ-を1つの.hファイルに集め記載する。

hello.h

void hello();

②実装は.cに書く

hello.c

# include <stdio.h>

void hello() {
    printf("Hello, World!\n");
}

③tomlファイルにbindgenを追加する

Cargo.toml

[package]
name = "tmp"
version = "0.1.0"
edition = "2018"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[build-dependencies]
bindgen = "0.59.1"

④ビルド情報を記載する。
OUTディレクトリに.hから変換されたbindings.rsが生成される

Build.rs

extern crate bindgen;

use std::env;
use std::path::PathBuf;

fn main() {
     let bindings = bindgen::Builder::default()
        .header("src/hello.h")
        // Tell cargo to invalidate the built crate whenever any of the
        // included header files changed.
        .parse_callbacks(Box::new(bindgen::CargoCallbacks))
        // Finish the builder and generate the bindings.
        .generate()
        // Unwrap the Result and panic on failure.
        .expect("Unable to generate bindings");

    // Write the bindings to the $OUT_DIR/bindings.rs file.
    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());

        bindings
        .write_to_file(out_path.join("bindings.rs"))
        .expect("Couldn't write bindings!");

}

main.rs

include!(concat!(env!("OUT_DIR"), "/bindings.rs"));


fn main() {
    unsafe { hello(); }
}

⑤cargo buildでビルドするとoutフォルダ下にbuilding.rsが生成されている。Build.rsは自動生成されたbindings.rsをインクルードしてコンパイルされる。

環境構築で少しはまった。
LLVM clangがないと上手くいかない。以下のようなエラーメッセージが出る。

bindgenにはLLVMとclangが必要とあったのでLLVMとclangをインストール。