安全な Rust アプリケーション開発の指針標準ライブラリ
標準ライブラリ
Send トレイトと Sync トレイト
Send トレイトと Sync トレイト(std::marker または core::marker で定義)は、
Rust で並行処理の安全性を確保するために使われるマーカートレイトである。正しく
実装されていれば、Rust コンパイラはデータ競合が存在しないことを保証できる。
それぞれの意味論は次のとおりである。
どちらのトレイトも unsafe トレイト である。すなわち、Rust コンパイラは、それらが 正しく実装されているかどうかを一切検証しない。この危険は現実のものであり、誤った 実装は未定義動作につながりうる。
幸い、ほとんどの場合、これらを自分で実装する必要はない。Rust では、
ほぼすべてのプリミティブ型が Send かつ Sync であり、大半の複合型については
Rust コンパイラが実装を自動的に提供する。
Rustonomicon で述べられているとおり、主な例外は次のとおりである。
- 生ポインタは、安全のための保護を何も備えていないため、
SendでもSyncでも ない。 UnsafeCellは、内部可変性(可変な形で共有される値)を提供するため、Syncでは ない(その結果、CellとRefCellもSyncではない)。Rcは、参照カウンタが共有され、かつ同期されていないため、SendでもSyncでも ない。
複合型(構造体または列挙型)では、すべてのフィールドが Send な型
(または Sync な型)である場合に、Send(または Sync)が自動的に
実装される。
Send や Sync が自動的に実装されないようにするには、
PhantomData 型の内部フィールドを使えばよい。
# use std::marker::PhantomData;
#
struct SpecialType(u8, PhantomData<*const ()>);
比較トレイト(PartialEq、Eq、PartialOrd、Ord)
Rust の比較(==、!=、<、<=、>、>=)は、std::cmp
(no_std でコンパイルする場合は core::cmp)にある四つの標準トレイトに基づいている。
-
半同値関係を定義する。
-
半順序を定義する。
-
これは
PartialEq<Self>を要求するだけのマーカートレイトにすぎない。 -
PartialOrd<Self>が実装されていることを要求する。
標準ライブラリのドキュメントにあるとおり、Rust はこれらのトレイトの各実装について 多くの不変条件を前提としている。
-
PartialEqについて-
内部の一貫性:
a.ne(b)は!a.eq(b)と等価である。すなわち、neはeqの厳密な否定である。neの既定の実装は、まさに そのとおりになっている。 -
対称性:
a.eq(b)とb.eq(a)は等価である。開発者の 視点では、これは次を意味する。- 型
Aに対してPartialEq<B>が実装されている(A: PartialEq<B>と書く)。 - 型
Bに対してPartialEq<A>が実装されている(B: PartialEq<A>と書く)。 - 両方の実装が互いに整合している。
- 型
-
推移性:
a.eq(b)かつb.eq(c)ならばa.eq(c)である。これは次を意味する。A: PartialEq<B>B: PartialEq<C>A: PartialEq<C>- 三つの実装が互いに(また、それぞれの対称な実装とも) 整合している。
-
-
Eqについて-
PartialEq<Self>が実装されている。 -
反射性:
a.eq(a)が成り立つ。これはPartialEq<Self>に対する条件である(Eqは メソッドを一切提供しない)。
-
-
PartialOrdについて-
等価性との一貫性:
a.eq(b)はa.partial_cmp(b) == Some(std::cmp::Ordering::Equal)と等価である。 -
内部の一貫性:
a.partial_cmp(b) == Some(std::cmp::Ordering::Less)のとき、かつそのときに限りa.lt(b)a.partial_cmp(b) == Some(std::cmp::Ordering::Greater)のとき、かつそのときに限りa.gt(b)a.lt(b) || a.eq(b)のとき、かつそのときに限りa.le(b)a.gt(b) || a.eq(b)のとき、かつそのときに限りa.ge(b)
なお、
partial_cmpだけを定義すれば、内部の一貫性はlt、le、gt、geの既定の実装によって保証される。 -
反対称性:
a.lt(b)(またはa.gt(b))ならばb.gt(a)(またはb.lt(a))である。開発者の視点では、これは次のことも意味する。A: PartialOrd<B>B: PartialOrd<A>- 両方の実装が互いに整合している。
-
推移性:
a.lt(b)かつb.lt(c)ならばa.lt(c)である(gt、le、geについても同様)。これは次のことも意味する。A: PartialOrd<B>B: PartialOrd<C>A: PartialOrd<C>- これらの実装が互いに(また、それぞれの対称な実装とも)整合している。
-
-
Ordについて-
PartialOrd<Self> -
全順序性: 常に
a.partial_cmp(b) != Noneである。言い換えれば、a.eq(b)、a.lt(b)、a.gt(b)のうち、ちょうど一つが真である。 -
PartialOrd<Self>との一貫性:Some(a.cmp(b)) == a.partial_cmp(b)。
-
コンパイラは、型検査そのものを除いて、これらの要件を一切検査しない。
しかし、比較は極めて重要である。スケジューラやロードバランサのように
活性(処理が止まらずに進むこと)が重要なシステムにも、unsafe ブロックを
使うことのある最適化されたアルゴリズムにも関わるからである。
前者では、順序付けが誤っていると、デッドロックのような可用性の問題に
つながりうる。
後者では、メモリ安全性の侵害に関連する古典的なセキュリティ問題に
つながりうる。これもまた、unsafe ブロックの使用を制限するという実践を
後押しする要因である。
安全な Rust 開発では、標準の比較トレイトの実装は、 ドキュメントに記載された不変条件を守らなければならない。
安全な Rust 開発では、標準の比較トレイトの実装は、 トレイトに結び付いた不変条件を破るリスクを減らすため、既定の実装を持たない メソッドだけを定義すべきである。
PartialEq の実装で PartialEq::ne が定義されていないことを検査する
Clippy のリントがある。
Rust には、#[derive(...)] 属性によって比較トレイトの実装を自動的に生成する
標準的な方法がある。
PartialEqの導出は、各部分型がPartialEq<Self>であることを条件に、 構造的等価性によるPartialEq<Self>を実装する。Eqの導出は、各部分型がEqであることを条件に、 マーカートレイトEqを実装する。PartialOrdの導出は、各部分型がPartialOrdであることを条件に、 辞書式順序によるPartialOrd<Self>を実装する。Ordの導出は、各部分型がOrdであることを条件に、 辞書式順序によるOrdを実装する。
例えば、次の短いコードは、二つの T1 を簡単に比較する方法を示している。
アサーションはすべて成り立つ。
#[derive(PartialEq, Eq, PartialOrd, Ord)]
struct T1 {
a: u8, b: u8
}
# fn main() {
assert!(&T1 { a: 0, b: 0 } == Box::new(T1 { a: 0, b: 0 }).as_ref());
assert!(T1 { a: 1, b: 0 } > T1 { a: 0, b: 0 });
assert!(T1 { a: 1, b: 1 } > T1 { a: 1, b: 0 });
# println!("all tests passed.");
# }
複合型に対する比較トレイトの導出は、フィールドの名前ではなく、 フィールドの順序に依存する。
第一に、これは、二つのフィールドの宣言順を入れ替えると、 結果として得られる辞書式順序が変わることを意味する。例えば、次のような二つ目の 順序付き型があるとする。
#[derive(PartialEq, Eq, PartialOrd, Ord)]
struct T2{
b: u8, a: u8
};
このとき、T1 {a: 1, b: 0} > T1 {a: 0, b: 1} であるが、
T2 {a: 1, b: 0} < T2 {a: 0, b: 1} となる。
第二に、内部で行われる比較のいずれかがパニックする場合、自動実装では 短絡評価が使われるため、順序によって結果が変わりうる。
列挙型の場合、導出された比較は、まずバリアントの順序に、次に フィールドの順序に依存する。
順序に関するこの注意点はあるものの、導出による比較は手動で実装した比較よりも はるかに誤りが起きにくく、コードも短く保守しやすくなる。
安全な Rust 開発では、構造的等価性と辞書式比較が必要な場合、
標準の比較トレイトの実装は #[derive(...)] で自動的に導出
すべきである。標準の比較トレイトを手動で実装する場合は、
文書化し、正当化すべきである。
Drop トレイト(デストラクタ)
型は、その型の値に対応するメモリが回収されるときに何らかの処理を行うために、
std::ops::Drop トレイトを実装する。Drop は、C++ のデストラクタや
Java のファイナライザに相当する Rust の仕組みである。
このトレイトを実装すると、言語の実行時の意味論が変わる。
ドロップは、外側の値から内側の値へと再帰的に行われる。
値がスコープを抜けるとき(または mem::drop で明示的にドロップされるとき)、
その値は二段階でドロップされる。第一段階は、その値の型が Drop を
実装している場合にのみ行われ、その値に対して mem::drop メソッドを呼び出す。
第二段階では、その値が含むすべてのフィールドに対して、ドロップの処理を
再帰的に繰り返す。なお、Drop の実装が
責任を負うのは外側の値だけである点に注意すること。
何よりもまず、Drop を一律に実装すべきではない。
必要になるのは、その型が何らかのデストラクタ処理を要する場合だけである。実際、Drop は
典型的には、外部リソース(ネットワーク接続、ファイルなど)の解放や、
メモリの解放(例えば Box や Rc のようなスマートポインタ)に使われる。
その結果、Drop トレイトの実装には、unsafe なコードブロックや、
セキュリティ上重要なその他の操作が含まれやすい。
安全な Rust 開発では、std::ops::Drop トレイトの実装は、
正当化し、文書化しなければならない。
次に、Rust の型システムが保証するのはメモリ安全性だけであり、型システムの 観点では、ドロップが行われないことは許容されている。実際、次のように、 ドロップが行われない原因はいくつもある。
- 参照の循環(例えば
RcやArcによるもの) mem::forgetの明示的な呼び出し(mem::forgetとメモリリークの項を参照)- ドロップ中のパニック
- プログラムのアボート(および、パニック時にアボートする設定が有効な場合のパニック)
そして、ドロップが行われないと、機密データが露出したり、限りあるリソースが ロックされたままになって可用性の問題につながったりするおそれがある。
安全な Rust 開発では、std::ops::Drop トレイトの実装は
パニックしてはならない。
パニック以外についても、セキュリティ上重要なドロップは保護すべきである。
Drop を実装する型の値を、参照カウント方式の参照の循環の中に、直接的にも
間接的にも組み込んではならない。
(循環する参照カウントポインタの節を参照)
何らかの処理の終わりに行うセキュリティ上の操作(暗号化処理の終わりに行う
鍵の消去など)を、Drop トレイトの実装だけに頼って保証しては
ならない。
循環する参照カウントポインタ(Rc と Arc)
参照カウントポインタを使うと、任意の型の値を複製(クローン)できる。 そのために、これらの値には、その値に結び付いたクローンの数を数えるカウンタが対応付けられ、 カウンタがゼロになると値が破棄される。
この方式では、参照カウントポインタが循環して使われると、メモリリークが生じうる。
この例では、オブジェクト A、B、C はそれぞれ、少なくとも一つのほかのオブジェクトから参照されている。これら三つのオブジェクトが存在する限り、
いずれも削除されない。その結果、メモリリークになる。
型定義の中で内部可変性、再帰、参照カウントポインタを組み合わせることは安全ではない。メモリリークを引き起こす可能性があり、それが DDoS 攻撃や秘密情報の漏えいにつながりうる。
次の例は、安全な Rust でこのようなメモリリークが起きることを示している。
悪い例
use std::{cell::Cell, rc::Rc};
struct LinkedStruct {
other: Cell<Option<Rc<LinkedStruct>>>,
}
fn main() {
println!("Hello, world!");
let a = Rc::new(LinkedStruct {
other: Cell::new(None),
});
let b = Rc::new(LinkedStruct {
other: Cell::new(None),
});
let aa = a.clone();
let bb = b.clone();
a.other.set(Some(bb));
b.other.set(Some(aa));
}
メモリリークは valgrind で確認できる。
$ valgrind --leak-check=full target/release/safe-rust-leak
==153637== Memcheck, a memory error detector
==153637== Copyright (C) 2002-2022, and GNU GPL'd, by Julian Seward et al.
==153637== Using Valgrind-3.19.0 and LibVEX; rerun with -h for copyright info
==153637== Command: target/release/safe-rust-leak
==153637==
Hello, world!
==153637==
==153637== HEAP SUMMARY:
==153637== in use at exit: 48 bytes in 2 blocks
==153637== total heap usage: 10 allocs, 8 frees, 3,144 bytes allocated
==153637==
==153637== 48 (24 direct, 24 indirect) bytes in 1 blocks are definitely lost
in loss record 2 of 2
==153637== at 0x48417B4: malloc (vg_replace_malloc.c:381)
==153637== by 0x10F8D4: safe_rust_leak::main
(in /home/toto/src/safe-rust-leak/target/release/safe-rust-leak)
==153637== by 0x10F7E2: std::sys::backtrace::__rust_begin_short_backtrace
(in /home/toto/src/safe-rust-leak/target/release/safe-rust-leak)
==153637== by 0x10F7D8: std::rt::lang_start::{{closure}}
(in /home/toto/src/safe-rust-leak/target/release/safe-rust-leak)
==153637== by 0x12A90F: std::rt::lang_start_internal
(in /home/toto/src/safe-rust-leak/target/release/safe-rust-leak)
==153637== by 0x10FA54: main
(in /home/toto/src/safe-rust-leak/target/release/safe-rust-leak)
==153637==
==153637== LEAK SUMMARY:
==153637== definitely lost: 24 bytes in 1 blocks
==153637== indirectly lost: 24 bytes in 1 blocks
==153637== possibly lost: 0 bytes in 0 blocks
==153637== still reachable: 0 bytes in 0 blocks
==153637== suppressed: 0 bytes in 0 blocks
==153637==
==153637== For lists of detected and suppressed errors, rerun with: -s
==153637== ERROR SUMMARY: 1 errors from 1 contexts (suppressed: 0 from 0)
参照カウントポインタによって再帰する再帰型を、内部可変性と併用してはならない。