3.10 PhantomData

译文 · 基于 The Rustonomicon

PhantomData

原文链接: https://doc.rust-lang.org/nomicon/phantom-data.html

　　处理 unsafe 代码时，常会遇到类型或生命周期在逻辑上与结构体关联，却并非实际字段的情况。最常见的是生命周期。例如 &'a [T] 的 Iter（近似）定义如下：

struct Iter<'a, T: 'a> {
    ptr: *const T,
    end: *const T,
}

　　但由于 'a 在结构体体内未使用，它是无界的。 　　因历史上由此引发的问题， 　　结构体定义中禁止无界生命周期和类型。 　　因此必须在体内以某种方式引用这些类型。 　　正确做法是获得正确的型变和 drop 检查。

　　我们使用 PhantomData——一种特殊标记类型。PhantomData 　　不占空间，但在静态分析中模拟给定类型的字段。这比显式告诉类型系统期望的型变种类更不易出错，同时提供 auto trait 和 drop 检查所需信息等有用特性。

　　Iter 在逻辑上包含一堆 &'a T，因此正是我们让 PhantomData 模拟的：

1
2
3
4
5
6
7

use std::marker;

struct Iter<'a, T: 'a> {
    ptr: *const T,
    end: *const T,
    _marker: marker::PhantomData<&'a T>,
}

　　就这样。生命周期会有界，迭代器对 'a 和 T 协变。一切正常运行。

泛型参数与 drop 检查

　　过去还有另一点需要考虑。

　　本文档曾写道：

另一个重要例子是 Vec，（近似）定义如下：

1 2 3 4 5

struct Vec<T> { data: *const T, // *const 用于型变！ len: usize, cap: usize, }

与上一例不同，看似一切正是我们想要的。Vec 的每个泛型参数都出现在至少一个字段中。 可以开始了！

并非如此。

drop 检查器会宽松地判定 Vec<T> 不拥有任何 T 类型的值。进而认为不必在确定 drop 检查 soundness 时担心 Vec 在析构函数中 drop 任何 T。进而允许人们利用 Vec 的析构函数制造 unsoundness。

要告诉 drop 检查器我们确实拥有 T 类型的值，因此在我们 drop 时可能 drop 一些 T，必须添加额外的 PhantomData 明确说明：

1 2 3 4 5 6 7 8

use std::marker; struct Vec<T> { data: *const T, // *const 用于型变！ len: usize, cap: usize, _owns_T: marker::PhantomData<T>, }

　　但自 RFC 1238 起， 　　这已不再成立，也不再必要。

　　若你写成：

1
2
3
4
5
6
7
8

struct Vec<T> {
    data: *const T, // `*const` 用于型变！
    len: usize,
    cap: usize,
}

# #[cfg(any())]
impl<T> Drop for Vec<T> { /* … */ }

　　则 impl<T> Drop for Vec<T> 的存在使 Rust 认为该 Vec<T> 拥有 T 类型的值（更准确地说：可能在 Drop 实现中使用 T 类型的值），因此 drop Vec<T> 时不允许它们 悬垂（dangle）。

　　若类型已有 Drop impl，再添加 _owns_T: PhantomData<T> 字段 　　对 dropck 而言是 多余的，毫无作用（仍影响型变和 auto trait）。

• （高级边角：若包含 PhantomData 的类型完全没有 Drop impl， 　　 但仍有 drop glue（因另一个字段有 drop glue），则本文提到的 dropck/#[may_dangle] 考虑同样适用：此时 PhantomData<T> 字段会在包含类型离开作用域时要求 T 可 drop。）

　　但这有时会导致过度严格的代码。因此标准库使用 unstable 且 unsafe 的属性，选择回到本文档曾警告的旧「未检查」drop 检查行为：#[may_dangle] 属性。

例外：标准库及其 unstable #[may_dangle] 的特殊情况

　　若你只写自己的库代码，可跳过本节；但若好奇标准库实际 Vec 定义，你会注意到它仍需要 _owns_T: PhantomData<T> 字段以保证 soundness。

1
2
3
4
5
6

fn main() {
    let mut v: Vec<&str> = Vec::new();
    let s: String = "Short-lived".into();
    v.push(&s);
    drop(s);
} // <- `v` 在此被 drop

1

unsafe impl<#[may_dangle] 's> Drop for Vec<&'s str> { /* … */ }

1

unsafe impl<#[may_dangle] T> Drop for Vec<T> { /* … */ }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# #[cfg(any())]
// 我们郑重承诺 drop `Vec` 时不使用 `T`……
unsafe impl<#[may_dangle] T> Drop for Vec<T> {
    fn drop(&mut self) {
        unsafe {
            if mem::needs_drop::<T>() {
                /* … 除了这里，即…… */
                ptr::drop_in_place::<[T]>(/* … */);
            }
            // …
            dealloc(/* … */)
            // …
        }
    }
}

struct Vec<T> {
    // … 除了 `Vec` 拥有 `T` 项、
    // 因而 drop 时可能 drop `T` 项这一事实！
    _owns_T: core::marker::PhantomData<T>,

    ptr: *const T, // `*const` 用于型变（但这本身并不表达拥有 `T`）
    len: usize,
    cap: usize,
}

　　拥有内存分配的裸指针是如此普遍的模式，标准库为此提供了 Unique<T> 工具，它：

• 包装 *const T 以实现型变
• 包含 PhantomData<T>
• 自动 derive Send/Sync，仿佛包含 T
• 将指针标记为 NonZero 以实现空指针优化

PhantomData 模式表

　　下面是 PhantomData 各种用法的表格：

• 注：要退出 Unpin auto trait，需使用专用的 PhantomPinned 类型。