安全な Rust アプリケーション開発の指針unsafe Rust: メモリ管理
メモリ管理
unsafe でない Rust(すなわち unsafe を使わないコード)では、ほとんどの場合、プログラム中の値が占めるメモリをいつ解放できるかをコンパイラが自動的に判断する。
しかし、先に述べたとおり、これは保証では
ない。unsafe を使わないコードでもメモリリークは起こりうる。そのため、この章で示す
規則の一部は、unsafe キーワードに厳密には関係しない。ただし、
以下で取り上げる関数は、たとえ unsafe でなくても、
unsafe な Rust の中でのみ使うべきである。
原則として、メモリリークは避けなければならない。
安全な Rust 開発では、メモリリークは一切許されない。
mem::forget とメモリリーク
メモリは通常、変数がスコープを抜けることで回収されるが、Rust には
メモリを手動で回収するための特別な関数として、std::mem モジュール(または core::mem)の
mem::forget と mem::drop がある。mem::drop は、メモリの回収を早めに
引き起こすだけであり、必要に応じて対応するデストラクタを呼び出す。これに対し、
mem::forget はデストラクタの呼び出しを一切行わない。
let pair = ('↑', 0xBADD_CAFEu32);
drop(pair);
どちらの関数も、Rust ではメモリ安全である。しかし、mem::forget を使うと、
その値が管理していたリソースは到達不能になり、回収されないままになる。
悪い例
let s = String::from("Hello");
forget(s); // Leak memory
特に、mem::forget を使うと、重要なリソースが解放されずにデッドロックに
つながったり、機密データがメモリから消去されなかったりするおそれがある。このため、
mem::forget はセキュアではない。
安全な Rust 開発では、std::mem(core::mem)の mem::forget 関数を
使ってはならない。
mem::forget の使用を自動的に検出するために、Clippy のリント mem_forget を
使うべきである。クレート内で mem::forget が使われていないことを強制するには、
ルートファイル(通常は src/lib.rs または src/main.rs)の先頭に次の行を追加する。
#![deny(clippy::mem_forget)]
標準ライブラリには、値のドロップを忘れる方法がほかにもある。
ManuallyDrop(std::memまたはcore::mem): 値の解放を手動で行うよう強制する。
これらの代替手段も同じセキュリティ上の問題につながりうるが、 その目的がはっきり分かるという利点がある。
安全な Rust 開発では、コードは、特に Box::leak によって、メモリやリソースを
リークさせてはならない。
ManuallyDrop と Box::into_raw は、解放の責任をコンパイラから
開発者へ移す。
安全な Rust 開発では、ManuallyDrop でラップした値はすべて、
ラップを外して自動的に解放されるようにする(ManuallyDrop::into_inner)か、
手動で解放(unsafe な ManuallyDrop::drop)しなければならない。
生ポインタ
生ポインタは、主に C のポインタを扱うために使われる。スマートポインタのような保護は
なく、多くの場合 unsafe な文脈で使わなければならない。例えば、生ポインタの
解放は、Rust の保証なしに手動で行わなければならない。
unsafe を使わない安全な Rust 開発では、参照やスマートポインタを
生ポインタに変換すべきでない。例えば、スマートポインタ Box、Rc、Arc、rc::Weak、
sync::Weak の into_raw 関数や into_non_null 関数は使うべきでない。
それでも unsafe なコードなしで生ポインタを使う場合は、文書化し、正当化しなければならない。
安全な Rust 開発では、次のいずれかの型に対する into_raw
(または into_non_null)の呼び出しで作られたポインタは、
std::boxed::Box(またはalloc::boxed::Box)std::rc::Rc(またはalloc::rc::Rc)std::rc::Weak(またはalloc::rc::Weak)std::sync::Arc(またはalloc::sync::Arc)std::sync::Weak(またはalloc::sync::Weak)std::ffi::CStringstd::ffi::OsString
回収できるようにするため、最終的には、対応する from_raw の呼び出しで
値に戻さなければならない。
let boxed = Box::new(String::from("Crab"));
let raw_ptr = Box::into_raw(boxed);
let _ = unsafe { Box::from_raw(raw_ptr) }; // will be freed
逆もまた成り立つ。すなわち、from_raw は into_raw した値にのみ呼び出すべきである。例えば、
スマートポインタ Rc はこの条件を明示的に要求しており、
スマートポインタ Box については、C のポインタを Box に変換することは推奨されていない。
安全な Rust 開発では、from_raw は into_raw した値にのみ呼び出さなければならない。
Box::into_raw の場合、手動での後始末も可能ではあるが、生ポインタを
再び Box に戻すよりもはるかに複雑であり、避けるべきである。
悪い例
// Excerpt from the standard library documentation
use std::alloc::{Layout, dealloc};
use std::ptr;
let x = Box::new(String::from("Hello"));
let p = Box::into_raw(x);
unsafe {
ptr::drop_in_place(p);
dealloc(p as *mut u8, Layout::new::<String>());
}
未初期化メモリ
Rust は既定で、すべての値を初期化するよう強制し、未初期化メモリの使用を
防いでいる(std::mem::uninitialized または
std::mem::MaybeUninit を使う場合を除く)。
std::mem::uninitialized 関数(1.38 で非推奨)を使ってはならない。
std::mem::MaybeUninit 型(1.36 で安定化)は、必要な場合に限り、使用のたびに
明示的に正当化しなければならない。
未初期化メモリの使用は、二つの異なるセキュリティ上の問題を引き起こしうる。
- 未初期化メモリのドロップ(メモリ安全性の問題でもある)
- 初期化済みメモリがドロップされないこと
std::mem::MaybeUninit は std::mem::uninitialized を改善したものである。
実際、未初期化の値をドロップしてしまうことがはるかに起こりにくくなる。
しかし、二つ目の問題は変わらない。初期化済みメモリがドロップされない問題は
残る。これは、特に機密性の高いメモリを消去するために Drop を使うことを
考えると、問題である。