不安全代码

unsafe.md


commit 98b18fabddaa942c6bbbb44509b7c00f4b07915f

Rust 主要魅力是它强大的静态行为保障。不过安全检查天性保守：有些程序实际上是安全的，不过编译器不能验证它是否是真的。为了写这种类型的程序，我们需要告诉编译器稍微放松它的限制。为此，Rust 有一个关键字，unsafe。使用unsafe的代码比正常代码有更少的限制。

让我们过一遍语法，接着我们讨论语义。unsafe用在两个上下文中。第一个标记一个函数为不安全的：

  1. unsafe fn danger_will_robinson() {
  2.     // Scary stuff...
  3. }

例如所有从FFI调用的函数都必须标记为unsafe。第二个unsafe的用途是一个不安全块。

  1. unsafe {
  2.     // Scary stuff...
  3. }

第三个是不安全 trait：

  1. unsafe trait Scary { }

而第四个是impl这些 trait：

  1. # unsafe trait Scary { }
  2. unsafe impl Scary for i32 {}

显式勾勒出那些可能会有 bug 并造成大问题的代码是很重要的。如果一个 Rust 程序段错误了，你可以确认它位于标记为unsafe部分的什么地方。

“安全”指什么？（What does ‘safe’ mean?）

安全，在 Rust 的上下文中，意味着“不做任何不安全的事”。不过也要明白，有一些特定的行为在你的代码中可能并不合意，但很明显并不是不安全的：

  • 死锁
  • 内存或其他资源的泄露
  • 退出但未调用析构函数
  • 整型溢出

Rust 不能避免所有类型的软件错误。有 bug 的代码可能并将会出现在 Rust 中。这些事并不很光彩，不过它们并不特别的定义为unsafe。

另外，如下列表全是 Rust 中的未定义行为，并且必须被避免，即便在编写unsafe代码时：

  • 数据竞争
  • 解引用一个空/悬垂裸指针
  • 读undef（未初始化）内存
  • 使用裸指针打破指针重叠规则（pointer aliasing rules）
  • &mut T和&T遵循LLVM范围的noalias模型，除了如果&T包含一个UnsafeCell<U>的话。不安全代码必须不能违反这些重叠（aliasing）保证
  • 不使用UnsafeCell<U>改变一个不可变值/引用
  • 通过编译器固有功能调用未定义行为：
    • 使用std::ptr::offset（offset功能）来索引超过对象边界的值，除了允许的末位超出一个字节
    • 在重叠（overlapping）缓冲区上使用std::ptr::copy_nonoverlapping_memory（memcpy32/memcpy64功能）
  • 原生类型的无效值，即使是在私有字段/本地变量中：
    • 空/悬垂引用或装箱
    • bool中一个不是false（0）或true（1）的值
    • enum中一个并不包含在类型定义中判别式
    • char中一个代理字（surrogate）或超过char::MAX的值
    • str中非UTF-8字节序列
  • 在外部代码中使用Rust或在Rust中使用外部语言

不安全的超级力量（Unsafe Superpowers）

在不安全函数和不安全块，Rust 将会让你做 3 件通常你不能做的事：只有 3 件。它们是：

  1. 访问和更新一个静态可变变量
  2. 解引用一个裸指针
  3. 调用不安全函数。这是最 NB 的能力

这就是全部。注意到unsafe不能（例如）“关闭借用检查”是很重要的。为随机的Rust代码加上unsafe并不会改变它的语义，它并不会开始接受任何东西。

不过确实它会让你写的东西打破一些规则。让我们按顺序过一遍这3个能力。

访问和更新一个static mut

Rust 有一个叫static mut的功能，它允许改变全局状态。这么做可能造成一个数据竞争，所以它天生是不安全的。关于更多细节，查看静态量部分。

解引用一个裸指针

裸指针让你做任意的指针算数，并会产生一系列不同的内存安全（safety & security）问题。在某种意义上，解引用一个任意指针的能力是你可以做的最危险的事之一。更多关于裸指针，查看它的部分。

调用不安全函数

最后的能力能用于unsafe的两个方面：你只能在一个不安全块中调用被标记为unsafe的函数。

这个能力是强力和多变的。Rust 暴露了一些作为不安全函数的编译器固有功能，并且一些不安全函数绕开了安全检查，用安全换速度。

我在重复一遍：即便你可以在一个不安全块和函数中做任何事并不意味你应该这么做。编译器会表现得像你在保持它不变一样（The compiler will act as though you’re upholding its invariants），所以请小心。