はじめに

tomo-wait-for-it-yuki.hatenablog.com

前回の続きです。今回は、Rustを使うことによる生産性について、考察します。

言語仕様、エコシステム、コミュニティによる生産性向上

生産性は可視化が難しいです。そのため、本トピックではわかりやすく数値を比較するようなことは、できません。

Rustは厳格なルールをプログラマに課しますが、Rustの厳格なルールはバグを減らすことで、生産性の向上に寄与するでしょう。 Rustは、とりあえず動くものを作る時には、堅苦しい言語かもしれません。しかし、正しく動くものを作る時は、絶大な力を発揮します。

C言語はプログラマに最大限の自由を与え、その自由による責任をプログラマに負わせます。 Rustは、プログラマに義務に負わせ、その分保証を与えます。

unsafeブロックを含まないRustの関数は、コンパイルできた時点でスレッドセーフです。 Cでは、実行時の挙動からしか発見できないバグの多くが、Rustではコンパイラによって暴かれます。 Rustにおいて、コンパイルエラーと格闘することは、Rustのシンタックスを守るというより、正しい設計を考えることなのです。

また、プログラマが生産性を高めるための機能やエコシステムが整備されています。次のトピックについて、紹介します。

トレイト / ジェネクリクス
代数的データ型 / パターンマッチ
Cargo
LLVM
Rust Embedded WG

トレイト / ジェネリクス

他のプログラミング言語と同様に、Rustでもポリモーフィズムが利用できます。ポリモーフィズムを適切に利用することで、再利用性の高いコードを記述することができます。

Rustでは、トレイトとジェネリクス、という機能を使います。

トレイト

トレイトは、C++の抽象基底クラス、Javaのインタフェースに似たものです。例として、SPIデバイスにデータを書き込むためのトレイトを考えてみます。

世の中には様々なSPIデバイス（ここではSPI Masterを意味します）があります。ただ、SPIをインタフェースとして使うデバイスドライバやアプリケーションとしては、それを意識せず、汎用的に書きたいと思うのが普通です。

例えば、8-bit単位でレジスタにデータを書き込みできるSPIデバイスに書き込む関数は、次のように書くことができるでしょう。

/// ある8-bit単位で書き込めるSPIデバイスを表すstruct
struct MySpiU8 {
    ...
}

impl MySpiU8 {
    /// 書き込み関数。エラー処理は今は、考えません。
    fn write(&mut self, byte: u8) {
        // Do something for MySpiU8
        // 生ポインタを使って、メモリマップドデバイスに書き込みます。
        unsafe { &self.addr as *const _ as *mut u8　= word };
    }
}

このMySpiU8を使うアプリケーションは、MySpiU8専用のアプリケーションになってしまいます。

fn spi_write(spi: &mut MySpiU8, byte: u8) {
    spi.write(byte);
}

デバイスが例えばAnotherSpiU8に変わると、MySpiU8としている部分を書き直す必要があります。 SPIデバイスが変更になっても、アプリケーションを変更しなくて良いようにしたいです。

そこでトレイトの出番です。例えば、SPIデバイスの書き込み処理を行うトレイトを次のように定義します。これはあくまでも、インタフェースの定義です。

pub trait SpiWrite {
    fn write(&mut self, word: u8);
}

このトレイトを、MySpiU8やAnotherSpiU8に対して実装します。

impl SpiWrite for MySpiU8 {
    fn write(&mut self, word :u8) {
        // Do something for MySpiU8
        unsafe { unsafe { &self.addr as *const _ as *mut u8　= word };
    }
}

impl SpiWrite for AnotherSpiU8 {
    fn write(&mut self, word :u8) {
        // Do something for AnotherSpiU8
        unsafe { unsafe { &self.addr as *const _ as *mut u8　= word };
    }
}

このようにSpiWriteトレイトを実装している両者は、次のように同じコードで扱うことができます。

fn spi_write(spi: &mut SpiWrite, byte: u8) {
    spi.write(byte);
}

これでアプリケーションコードの再利用性を高めることができます。

ジェネリクス

Rustでポリモーフィズムを行うための、もう1つの方法です。これは、C++のテンプレートに相当します。

トレイトで使用したSPIの例（下記に再掲載）では、データが8-bit固定でした。しかし、SPI Masterによっては、16-bit単位でレジスタにデータを転送できるかもしれません。

pub trait SpiWrite {
    fn write(&mut self, word: u8);
}

今のトレイトでは、転送のデータ幅が変更になると、結局アプリケーションを変更しなければなりません。そこで、SpiWriteトレイトをジェネリック関数を使用するように修正します。

pub trait SpiWrite<W> {
    fn write(&mut self, word: W);
}

ここで、Wは任意の型であることを意味します。この修正により、write()関数は、任意の型Wに対して適用できるようになります。

MySpiU8とAnotherSpiU16があったとして、次のように定義します。任意の型Wに対して、u8とu16という具体的な型を与えます。

impl SpiWrite<u8> for MySpi {
    fn write(&mut self, word :u8) {
        // Do something for MySpiU8
        unsafe { unsafe { &self.addr as *const _ as *mut u8　= word };
    }
}

impl SpiWrite<u16> for AnotherSpi {
    fn write(&mut self, word :u16) {
        // Do something for AnotherSpiU8
        unsafe { unsafe { &self.addr as *const _ as *mut u16　= word };
    }
}

これらの書き込みデータの幅が異なる2つの実装に対して、下記の関数は共通して使用することができます。

fn spi_write<W: Clone>(spi: &mut SpiWrite<W>, data: W) {
    // `clone()`は明示的なコピーを行う関数で、`Clone`トレイトによって実装されます。
    spi.write(data.clone());
}

ここで、W: Cloneは、Cloneトレイトを実装する任意の型を意味します。この: Cloneの部分は、trait boundと呼ばれ、型Wに対して満たすべき制約を与えます。 C++をご存知の方は、次こそ入るであろうConceptのことだと考えて下さい。

上記関数内で、dataはclone()関数を持っていなければなりません。これを保証するのがCloneトレイトです。 trait boundにより、ジェネリクスが求めている型が、どのような特性を満足しなければならないか、を明示することができます。

トレイトオブジェクトとジェネリクス

さて、下記のspi_write()では、第一引数は&mut SpiWrite<W>を、第二引数は<W: Clone>を受け取ります。

fn spi_write<W: Clone>(spi: &mut SpiWrite<W>, data: W) {
    // `clone()`は明示的なコピーを行う関数で、`Clone`トレイトによって実装されます。
    spi.write(data.clone());
}

実は、この2つの使い方は、似て非なるものです。

前者の&mut SpiWrite<W>はトレイトオブジェクトと呼ばれます。後者の<W: Clone>はジェネリクスです。重要な違いは、トレイトオブジェクトが動的なポリモーフィズムを実現しているのに対して、ジェネリクスは静的なポリモーフィズムを実現している点です。

一般的に、ジェネリクスの方がより高速に動作します。ジェネリクスに対しては、コンパイラがコードを自動生成します。大雑把に言うと、今回の場合、spi_write()は次のような2つの関数に展開されます。

fn spi_write_u8(spi: &mut SpiWrite<u8>, data: u8) {
    spi.write(data.clone());
}

fn spi_write_u16(spi: &mut SpiWrite<u16>, data: u16) {
    spi.write(data.clone());
}

Rustでは、第一の選択肢はジェネリクスです。ただし、Vecのようなコレクションに複数の型を格納したい場合は、ジェネリクスは使えません。

トレイトオブジェクトとジェネリクスを使い分けることで、高速かつ抽象度の高いコードを記述することができます。

代数的データ型 / パターンマッチ

代数的データ型とパターンマッチの組み合わせを使うことで、直感的で安全な場合分け処理が記述できます。代数的データ型はenumとも呼ばれますが、想定読者が知っているC/C++のenumよりはるかに強力です。

代数的データ型

Rustのenumはデータを持つことができます。これは、どちらかというと共用体 (union) に似たものです。しかし、Rustのenumは安全です。

enc28j60 driverのコードから、enumを利用している箇所を引用します。

enum Register {
    Bank0(bank0::Register),
    Bank1(bank1::Register),
    Bank2(bank2::Register),
    Bank3(bank3::Register),
    Common(common::Register),
}

enumの要素である、Bank0やBank1はそれぞれ別の型を持っています。構造体を要素として持つこともできます。

もちろん、Cのenumと同様の使い方も可能です。

pub enum Register {
    ERDPTL = 0x00,
    ERDPTH = 0x01,
    EWRPTL = 0x02,
    EWRPTH = 0x03,
    ETXSTL = 0x04,
    ETXSTH = 0x05,
    ETXNDL = 0x06,
...
}

パターンマッチ

enumから値を取り出す時は、パターンマッチを使います。

    fn addr(&self) -> u8 {
        match *self {
            Register::Bank0(r) => r.addr(),
            Register::Bank1(r) => r.addr(),
            Register::Bank2(r) => r.addr(),
            Register::Bank3(r) => r.addr(),
            Register::Common(r) => r.addr(),
        }
    }

ここで重要なことは、Bank0型を格納すると、Bank0型としてしか取り出すことができない点です。 Cのunionと異なり、異なる型として処理することは、できません。

enumによるエラー定義

Rustのenumは、エラーを定義するときも便利です。例えば、異なるレイヤで発生したエラーを便利に定義することができます。 enc28j60は、SPIを使用したEthernet MACデバイスであるため、SPIレイヤのエラーと、MACレイヤのエラーが発生します。 MACレイヤでのエラーはより上位レイヤでのエラーと考えることができます。

SPIレイヤでは複数のエラーが、MACレイヤではLate Collisionのエラーが発生するとします。

pub enum Error<E> {
    /// Late collision
    LateCollision,
    /// SPI error
    Spi(E),
}

上記のようにError enumを定義すると、SPIレイヤのエラーは、さらに任意のE型のデータを持つことができます。まず、LateCollisionとSpiどっちのエラーなのかをパターンマッチで処理し、Spiの場合はさらに、E型に対する処理を行うことができます。

このように異なるデータを持つenumに対して、switch caseのノリで処理することができます。

    match error {
        LateCollision => { /* error handling for `LateCollision` */ }
        Spi(e) => {
            match e {
                /* error handling for each of `E` type. */
            }
        }
    }

enumを使ったエラーハンドリング

Rustのエラーハンドリングでは、Result<T, E>を使用します。処理が成功した時には、T型を、エラー発生時にはEを保持します。これは、ジェネリック (TとEが任意の型) な代数的データ型です。

例えば、SPIデバイスに8-bitのデータを書き込む関数を考えます。

Rustのembedded_halには、blocking::spi::Writeというtraitがあります。このtraitのwrite()関数は、SPIスレーブにW型のビット数単位で、データを送信します。一般的なSPIデバイスの送信動作です。受信はしないため、成功時に受け取るデータはありません。そのため、成功時には空のタプル()が返ってきます。

pub trait Write<W> {
    // 任意のエラー型を関連型`Error`として使うことができます
    type Error;
    fn write(&mut self, words: &[W]) -> Result<(), Self::Error>;
}

このwrite()の実装例は次のようになります。わかりやすいように、具体的な型を書きます。

/// SPIデバイスを表すstructです。
pub struct Spi {
    ...
}

/// SPIのエラー定義です。
#[derive(Debug)]
pub enum SpiError {
    /// オーバーラン
    Overrun,
    /// モードフォルト
    ModeFault
}

/// `Write` traitをSpi structに実装します。
impl Write<u8> for Spi {
    // Self::Errorは、上で定義している`SpiError`になります。
    type Error = SpiError;

    fn write(&mut self, bytes: &[u8]) -> Result<(), SpiError> {
        // ステータスレジスタを読み込みます
        let status = self.sr.read();

        // SPIデバイスがエラー状態であれば、エラーを返します
        if sr.ovr().bit_is_set() {
            return Error(SpiError::Overrun)
        } else if sr.modf().bit_is_set() {
            return Error(SpiError::ModeFault)
        }

        // エラー状態でなれば、データを送信します
        for byte in bytes.iter() {
            unsafe { ptr::write_volatile(&self.spi.addr as *const _ as *mut u8, byte) }
        }
        Ok(())
    }
}

このSpiを使用するアプリケーションは、次のようにエラーハンドリングできます。

match spi.write(&data) {
    Ok(_) => { /* 成功時の処理 */ }
    Error(e) => {
        match e {
            SpiError::Overrun => { /* オーバーランのエラー処理 */ }
            SpiError::ModeFault => { /* モードフォールドのエラー処理 */ }
        }
    }
}

この例では愚直に書いていますが、エラーを上位に伝播する方法や、他のエラーと合成する方法など、様々なエラー処理がうまく書けるようになっています。

このように、代数的データ型とパターンマッチを使うことで、C言語よりはるかに強力で安全な場合分け処理を実現することができます。

Cargo

Cargoは、Rustのビルドシステム兼パッケージマネージャです。何でも卒なくこなしてくれる頼もしい貨物です。 Rustによる快適開発ライフの3分の1くらいを担っていると思います。

package manager

まず、パッケージマネージャとして、こなして欲しい仕事を全て面倒見てくれます。

セマンティックバージョニングで依存関係を管理
依存関係を、crates.io, git, pathの形で指定可能
Cargo.lockでビルドの再現性を確保
srcディレクトリ以下のファイルを自動で解析してビルド

crates.ioは、Rustのcrate (パッケージ) を登録する場所です。ここにあるcrateであれば、cargoの設定ファイルCargo.tomlに次のように書くだけで、依存を解決してくれます。

[dependencies]
time = "0.1.12"

ローカルにtime crateがない場合、ソースコードを取得して、最終バイナリまで一気にビルドしてくれます。 crateのバージョンは、完全に指定することもできますし、セマンティックバージョニングで互換性が崩れない範囲で最新のものを取得することもできます。

gitで取得可能なcrateや、自身のプロジェクトの中で小さなcrateを複数使っても、簡単に管理できます。そのためRustでは小さなcrateを多く作ることが多いです。そうしても管理コストはあまり増えませんし、再利用できる部品が増えます。

[dependencies]
rand = { git = "https://github.com/rust-lang-nursery/rand" }
my_utils = { path = "../my_utils" }

srcディレクトリ下のファイルで、トップ (main.rsかlib.rs) から辿って利用しているソースファイルは自動的にビルドします。面倒な設定は必要ありません。

project configuration

.cargo/configに様々な設定を記述することができます。組込みRustでは非常にお世話になります。

例えば、RISC-V向けのクロスコンパイラを使用し、カスタムリンカスクリプトを指定、実行時にはqemu-riscvを立ち上げるようにします。これは、.cargo/configに次のように記述するだけです (ツールのインストールは別途必要です)。

# ビルドターゲットがRISC-Vの時の設定です
[target.riscv32imac-unknown-none-elf]
# ランナーとしてqemu-riscvを使います
runner = "qemu-system-riscv32 -nographic -machine sifive_u -kernel"
# 自作のリンカスクリプトでリンクします
rustflags = [
  "-C", "link-arg=-Tlinker.ld",
]

# デフォルトでRISC-Vをビルドターゲットにします
[build]
target = "riscv32imac-unknown-none-elf"

このように設定ファイルを用意すると、

cargo run

だけで、RISC-Vのバイナリが生成され、qemuでバイナリを実行します。

build script

ビルド時にRustで記述したビルドスクリプトを実行することができます。例えば、依存するC言語のライブラリをビルドしたり、アセンブリで書いたブートストラップをビルドした上で、Rustのコードとリンクすることができます。

cc crateを使うと、非常に容易です。

extern crate cc;

fn main() -> Result<(), Box<Error>> {
    Build::new()
        .file("boot.s")
        .flag("-mabi=ilp32")
        .compile("asm");

    Ok(())
}

これで、boot.sをコンパイルして、Rustのコードとリンクしてくれます。ただし、クロスコンパイラを使う場合は、環境変数の設定が必要です。

コマンドラインでやる場合、次のようになります。

$ env CC=riscv32-unknown-linux-gnu-gcc  cargo run

external tools

binutils

cargoはプラグインシステムがあるため、サブコマンドを自由に作ることができます。組込みで一番有用なのは間違いなくbinutilsでしょう。

次のコマンドでプラグインをインストールするだけで、cargoのサブコマンドとしてbinutilsが利用可能です。

$ rustup component add llvm-tools-preview
$ cargo install cargo-binutils --vers 0.1.4

下のような感じで使うことができます。

$ cargo objdump --bin app -- -d -no-show-raw-insn

フォーマッタ、lintツール

Rustのフォーマッタや、ソースコードを静的解析するlintツールもCargoのサブコマンドとして使うことができます。

cargo fmt
cargo clippy

LLVM

RustはLLVMをバックエンドに持つプログラミング言語であるため、クロスコンパイルがお手軽です。 ARMv7のクロスコンパイラをインストールするのは、コマンド1つです。

$ rustup target add thumbv7m-none-eabi

Rust Embedded WG

Rustの開発はコミュニティが行っています。注力分野として組込みも挙げられており、Embedded WGがあります。

このEmbedded WGは、組込み開発で使用するcrateを開発したり、学習用ドキュメントを整備しています。また、Rust本体に組込みで欲しい機能を要望するブリッジとしての役割も担っています。

下のようなターゲットに、注力しています。

Cortex-A
Cortex-M
Cortex-R
MSP430
RISC-V
組込みLinux

また、SVD (System View Description)ファイルから、マイコンのペリフェラルにアクセスするRustコードを自動生成する、svd2rustのようなツール開発も行われています。

低レイヤ強くなりたい組込み屋さんのブログ

低レイヤに、強くなる！

組込みRust考察②～効率良く安全な組込み開発をしたい～