clarify changed init signature
[web.git] / ralf / _posts / 2018-04-05-a-formal-look-at-pinning.md
1 ---
2 title: "A Formal Look at Pinning"
3 categories: research rust
4 forum: https://internals.rust-lang.org/t/a-formal-look-at-pinning/7236
5 ---
6
7 Recently, a new API for "pinned references" has [landed as a new unstable feature](https://github.com/rust-lang/rust/pull/49058) in the standard library.
8 The purpose of these references is to express that the data at the memory it points to will not, ever, be moved elsewhere.
9 Others have [written](https://boats.gitlab.io/blog/post/2018-03-20-async-vi/) about why this is important in the context of async IO.
10 The purpose of this post is to take a closer, more formal look at that API: We are going to take a stab at extending the RustBelt model of types with support for pinning.
11
12 <!-- MORE -->
13
14 But before we get started, I have to lay down some basics.
15
16 ## Rust types: Recap
17
18 I have discussed my model of Rust types [in a previous post]({{ site.baseurl }}{% post_url 2018-01-31-sharing-for-a-lifetime %}); this may me a good time to read that post as I will be using it as a starting point.
19 The short version is that I view Rust types with private invariants as not having just a single invariant, but different invariants that reflect the different "modes" the type can be in.
20 @cramertj suggested to use "typestate" as terminology here, and I agree that this makes sense.
21
22 > **Definition 1: Rust types.** Every Rust type `T` comes with two typestates, each having an invariant:
23
24 > 1. The *owned* typestate with invariant `T.own(bytes)` (where `bytes: List<Byte>`), saying whether the given sequence of bytes constitutes a valid fully owned `T`.
25 1. The *shared* typestate with invariant `T.shr('a, ptr)` (where `'a: Lifetime` and `ptr: Pointer`), saying whether `ptr` is a valid pointer to an instance of `T` that has been shared for lifetime `'a`.
26
27 > Moreover, those two states must be connected in the sense that the following axiom always holds:
28
29 > {:type="a"}
30 1. If we have borrowed, for lifetime `'a`, a pointer `ptr` pointing to a list of bytes `bytes` such that `T.own(bytes)` holds, then we can move to the shared typestate and obtain `T.shr('a, ptr)`.  (Implicitly, when the original borrow ends, the type is moved back to the owned typestate.)
31
32 > This axiom ensures that we can create a shared reference to something we own.
33
34 You may be wondering why sharing is a separate typestate here; shouldn't that just be read-only access to a `T` that someone else owns?
35 However, that clearly doesn't work for `&Cell`; to explain types with interior mutability we *need* sharing as a separate state.
36 I explained this in more detail in the previous post, but as a quick example consider that, if you fully own a `RefCell`, the first field (storing the current count of readers/writers) has no special meaning whatsoever.
37 This is witnessed by [`RefCell::get_mut`](https://doc.rust-lang.org/beta/std/cell/struct.RefCell.html#method.get_mut) ignoring that field.
38 In fact, it would be sound to add a `RefCell::reset(&mut self)` that just resets this field to `0`.
39
40 ## Pinning
41
42 Now, let us extend our notion of types to also support pinning.
43 The core piece of the pinning API is a new reference type `Pin<'a, T>` that guarantees that *the data it points to will remain at the given location*, i.e. it will not be moved.
44 Crucially, **pinning does not provide immovable types**!
45 Data is only pinned after a `Pin<T>` pointing to it has been created; it can be moved freely before that happens.
46
47 The [corresponding RFC](https://github.com/rust-lang/rfcs/blob/master/text/2349-pin.md) explains the entirey new API surface in quite some detail: [`Pin`](https://doc.rust-lang.org/nightly/std/mem/struct.Pin.html), [`PinBox`](https://doc.rust-lang.org/nightly/std/boxed/struct.PinBox.html) and the [`Unpin`](https://doc.rust-lang.org/nightly/std/marker/trait.Unpin.html) marker trait.
48 I will not repeat that here but only show one example of how to use `Pin` references and exploit their guarantees:
49 {% highlight rust %}
50 #![feature(pin, arbitrary_self_types)]
51
52 use std::ptr;
53 use std::mem::Pin;
54 use std::boxed::PinBox;
55
56 struct SelfReferential {
57     data: i32,
58     self_ref: Option<ptr::NonNull<i32>>,
59 }
60
61 impl SelfReferential {
62     fn new() -> Self {
63         SelfReferential { data: 42, self_ref: None }
64     }
65
66     fn init(mut self: Pin<Self>) {
67         unsafe {
68             let this = Pin::get_mut(&mut self);
69             // Set up self_ref to point to this.data
70             this.self_ref = ptr::NonNull::new(&mut this.data as *mut _);
71         }
72     }
73     
74     fn read_ref(mut self: Pin<Self>) -> Option<i32> {
75         unsafe {
76             let this = Pin::get_mut(&mut self);
77             // Dereference self_ref if it is set
78             this.self_ref.map(|self_ref| *self_ref.as_ptr())
79         }
80     }
81 }
82
83 fn main() {
84     let mut s = PinBox::new(SelfReferential::new());
85     s.as_pin().init();
86     println!("{:?}", s.as_pin().read_ref()); // prints Some(42)
87 }
88 {% endhighlight %}
89 The most intersting piece of code here is `read_ref`, which dereferences a raw pointer.
90 The reason this is legal is that we can rely on the entire `SelfReferential` not having been moved since `init()` was called (which is the only place that would set the pointer to `Some`).
91
92 In particular, if we changed the signature to `fn init(&mut self)`, we could easily cause UB by writing the following code:
93 {% highlight rust %}
94 fn main() {
95     // Create an initialize a SelfReferential in a Box, move it out, and drop the Box
96     let s = { let b1 = Box::new(SelfReferential::new()); b1.init(); *b1 };
97     let mut b2 = PinBox::new(s); // move the initialized SelfReferential into a new PinBox
98     println!("{:?}", b2.as_pin().read_ref()); // Cause explosion
99 }
100 {% endhighlight %}
101 Now `read_ref()` will dereference a pointer into the memory that was allocated for `b1`, but has since then been deallocated!
102 This is clearly wrong.
103
104 This example also shows that there cannot be a safe conversion from `&mut T` to `Pin<T>`: That would let us implement the problematic `init_ref(&mut self)` by calling `init(self: Pin<Self>)`.
105 In contrast, converting `Box<T>` to `PinBox<T>` is fine because this *consumes* the `Box`, so nobody will ever get "unpinned" access to it.
106
107 `Pin` lets us give a type to `SelfReferantial` that makes it safe to use.
108 This is in the best tradition of Rust: We are using an expressive type system to provide safe APIs for operations that only have unsafe APIs in other languages (e.g., iterators that avoid iterator invalidation which plague even memory safe languages like Java).
109 In the following, I will explain how one can prove that our claim of safe encapsulation actually holds true.
110 This is building on the framework that we developed for the [RustBelt paper]({{ site.baseurl }}{% post_url 2017-07-08-rustbelt %}).
111
112 ## Formal Notation
113
114 Before we go on, I'd like to introduce some notation to make it easier to talk about ownership and borrowing of memory in a precise way.
115 I feel like trying to express this all just in English and leaving away the formalism is not actually making it easier to understand.
116 The full formalism we use in the paper is probably overkill, so I will go with a simplified version that glosses over many of the details.
117
118 For example, the axiom (a) stated above would look as follows:
119 ```
120 forall |'a, ptr|
121   borrowed('a, exists |bytes| ptr.points_to_owned(bytes) && T.own(bytes))
122   -> T.shr('a, ptr)
123 ```
124 I am using the usual mathematical quantifiers, with a Rust-y syntax (`forall |var| P` and `exists |var| P`), and `->` for implication.
125 For disjunction (`||`) and conjunction (`&&`), I follow Rust.
126
127 We also need some way to talk about ownership and contents of memory:
128 I will write `ptr.points_to_owned_bytes(bytes)` (where `ptr: Pointer` and `bytes: List<Byte>`) to express that `ptr` points to `bytes.len()` many bytes of memory containing the given `bytes` of data, and that moreover, we *own* that memory.
129 Ownership here means that we are free to read, write and deallocate that memory.
130
131 Frequently, it is more convenient to not talk about raw lists of bytes but about some higher-level representation of the bytes, and not care about how exactly that data is laid out in memory.
132 For example, we might want to say that `ptr` points to `42` of type `i32` by saying `ptr.points_to_owned(42i32)`.
133 We can define a suitable `points_to_owned` as
134 ```
135 ptr.points_to_owned(data: U) where List<Bytes>: TryInto<U> :=
136   exists |bytes| bytes.try_into() == Ok(data) && ptr.points_to_owned_bytes(bytes)
137 ```
138 Here, we (ab)use the `TryInto` trait to convert a properly laid out list of bytes into something of type `U`.
139 The conversion fails, in particular, if the list does not have exactly the right length.
140 If `U == List<Bytes>`, this is just the same as `ptr.points_to_owned_bytes`.
141
142 **Update:** In a previous version I called these predicates `mem_own_bytes` and `mem_own`. I decided that `points_to_owned` was actually easier to understand, and it also matches the standard terminology in the literature, so I switched to using that term instead. **/Update**
143
144 Finally, `borrowed('a, P)` says that `P` is only temporarily owned, i.e., borrowed, for lifetime `'a`.
145 `P` here is a *proposition* or *assertion*, i.e., a statement about what we expect to own. The axiom above is a proposition, as is `ptr.points_to_owned(42i32)`.
146 You can think of propositions as a fancy version of `bool` where we can use things like quantifiers or borrowing, and talk about memory and ownership.
147
148 Let us see how we can define the owned typestate of `Box` and mutable reference using this notation:
149
150 > **Definition 2: `Box<T>.own` and `(&'a mut T).own`.**
151 A `Box<T>` is a list of bytes that make up a pointer, such that we own the memory this pointer points to and that memory satisfies `T.own`.
152 `&'a mut T` is almost the same, except that memory and `T.own` are only borrowed for lifetime `'a`.
153 Formally:
154 ```
155 Box<T>.own(bytes) := exists |ptr, inner_bytes| bytes.try_into() == Ok(ptr) &&
156   ptr.points_to_owned(inner_bytes) && T.own(inner_bytes)
157 ```
158 ```
159 (&'a mut T).own(bytes) := exists |ptr| bytes.try_into() == Ok(ptr) &&
160   borrowed('a,
161     exists |inner_bytes| ptr.points_to_owned(inner_bytes) && T.own(inner_bytes))
162 ```
163
164 It turns out that using `try_into` like we do above is actually a common pattern.
165 We usually do not want to talk directly about the `List<Byte>` but convert them to some higher-level representation first.
166 To facilitate this, we will typically define `T.own(data: U)` for some `U` such that `List<Byte>: TryInto<U>`, the idea being that the raw list of bytes is first converted to a `U` and the predicate can then directly access the higher-level data in `U`.
167 This could look as follows:
168 ```
169 Box<T>.own(ptr: Pointer) :=
170   exists |inner_bytes| ptr.points_to_owned(inner_bytes) && T.own(inner_bytes)
171 ```
172 ```
173 (&'a mut T).own(ptr: Pointer) :=
174   borrowed('a, exists |inner_bytes| ptr.points_to_owned(inner_bytes) && T.own(inner_bytes))
175 ```
176 The actual ownership predicate is then defined as
177 ```
178 exists |data: U| bytes.try_into() == Ok(data) && T.own(data)
179 ```
180
181
182 ## Extending Types to Verify `SelfReferential`
183
184 What would it take to *prove* that `SelfReferential` can be used by arbitrary safe code?
185 We have to start by writing down the private invariants (for all typestates) of the type.
186 We want to say that if `self.read_ref` it set to `Some(data_ptr)`, then `data_ptr` is the address of `self.data`.
187 However, if we go back to our notion of Rust types that I laid out at the beginning of this post, we notice that it is *impossible* to refer to the "address of `self.data`" in `T.own`!
188 And that's not even surprising; this just reflects the fact that in Rust, if we own a type, we can always move it to a different location---and hence the invariant must not depend on the location.
189
190 So, to write down our invariant, we need to extend our notion of types.
191 We will add a new, *third* typestate on top of the existing owned and shared typestates:
192
193 > **Definition 3a: Rust types with pinning.**  Extend definition 1 with a new typestate:
194
195 > {:start="3"}
196 3. The *pinned* state with invariant `T.pin(ptr)` (where `ptr: Pointer`), saying whether `ptr` is a valid pointer to an instance of `T` that is considered pinned.
197
198 Notice that this state talks about a *pointer* being valid, in contrast to `T.own` which talks about a *sequence of bytes*.
199 This gives us the expressivity we need to talk about immovable data:
200 `SelfReferential.pin(ptr)` says that `ptr` points to some memory we own, and that memory stores some pair `(data, self_ref)`.
201 (In terms of memory layout, `SelfReferential` is the same as a pair of `i32` and `Option<ptr::NonNull<i32>>`.)
202 Moreover, if `self_ref` is set to `Some(data_ptr)`, then `data_ptr` is the address of the first field of the pair:
203 ```
204 SelfReferential.pin(ptr) := exists |data: i32, self_ref: Option<ptr::NonNull<i32>>|
205   ptr.points_to_owned((data, self_ref)) &&
206   match self_ref { Some(data_ptr) => data_ptr.as_ptr() == ptr.offset(0), None => True }
207 ```
208 The most important part of this is the last line, saying that if `data_ptr` is a `Some`, it actually points to the first field (at offset `0`).
209 (I am of course glossing over plenty of details here, like handling of padding, but those details are not relevant right now.
210 Moreover, `SelfReferential` also has an owned and a shared typestate, but nothing interesting happens there.)
211
212 With this choice, it is easy to justify that `read_ref` is safe to execute: When the function begins, we can rely on `SelfReferential.pin(self)`.
213 If the closure in `self_ref.map` runs, we are in the `Some` case of the `match` so the deref of the pointer obtained from `self_ref` is fine.
214
215 ## Verifying the Pin API
216
217 With our notion of types extended with a pinned typestate, we can now justify the `Pin` and `PinBox` API.
218 We will start with the methods that work for *all* types, and talk about the additional methods that require `Unpin` later.
219 Along the way, we will discover which additional axioms we need to add to connect our new pinned typestate to the existing ones.
220 This is where we get really technical.
221
222 Again, to verify a type, we first have to define its invariant for all typestates.
223 Let us focus on the *owned* typestate:
224
225 > **Definition 4: `PinBox<T>.own` and `Pin<'a, T>.own`.**
226 A list of bytes makes a valid `PinBox<T>` if those bytes form a pointer `ptr` such that we own `T.pin(ptr)`.
227 For `Pin<'a, T>`, `ptr` is valid if we have borrowed `T.pin(ptr)` for lifetime `'a`.
228 ```
229 PinBox<T>.own(ptr) := T.pin(ptr)
230 ```
231 ```
232 Pin<'a, T>.own(ptr) := borrowed('a, T.pin(ptr))
233 ```
234
235 Let us start with the `impl<T> From<Box<T>> for PinBox<T> `, which can turn a `Box<T>` into a `PinBox<T>` in-place.
236 We can assume that `self` satisfies the owned typestate invariant of `Box<T>`, and we have to prove that our return value (which is the same pointer) satisfies the owned typestate invariant of `PinBox<T>`.
237 To justify this conversion, we need to turn a pointer to a fully owned `T` into a pinned `T` at the same location.
238 This seems like a reasonable principle to require in general, so we add it to our definition of types:
239
240 > **Definition 3b: Rust types with pinning.**  Extend definition 3a with a new axiom:
241
242 > {:type="a" start="2"}
243 2. If we own a pointer `ptr` pointing to a list of bytes `bytes` such that `T.own(bytes)` holds, then we can move to the pinned typestate and obtain `T.pin(ptr)`. Formally:
244 ```
245 forall |ptr, bytes| (ptr.points_to_owned(bytes) && T.own(bytes)) -> T.pin(ptr)
246 ```
247
248 `PinBox::new` can now be easily implemented using `Box::new` and `PinBox<T>::from`.
249
250 For `PinBox::as_pin`, we start with a `&'a mut PinBox<T>`, which is a pointer-to-pointer, and return the inner pointer as `Pin<'a, T>`.
251 This is justified because we start with a borrow for lifetime `'a` of a pointer to some `bytes` that satisfy (for the given lifetime) `PinBox<T>.own(bytes)`:
252 ```
253 borrowed('a, exists |bytes| ptr.points_to_owned(bytes) && PinBox<T>.own(bytes))
254 ```
255 Unfolding the `PinBox<T>.own`, we can deduce that `bytes` actually form a pointer `inner_ptr` such that `T.pin(inner_ptr)` (for the given lifetime).
256 This exactly matches our return type, so we're good!
257
258 Finally, let us look at `impl<T> Deref for PinBox<T>`.
259 This is where the shared typestate of `PinBox` becomes relevant:
260 This `impl` turns a `&'a PinBox<T>` into a `&'a T` by dereferencing it once.
261 To justify this, we have to be able to move from the pinned typestate of `T` to the shared typestate, which we require as our final additional axiom:
262
263 > **Definition 3c: Rust types with pinning.**  Extend definition 3b with a new axiom:
264
265 > {:type="a" start="3"}
266 3. If we have borrowed, for lifetime `'a`, a pointer `ptr` such that `T.pin(ptr)` holds, then we can move to the shared typestate and obtain `T.shr('a, ptr)`.  (Implicitly, when the original borrow ends, the type is moved back to the owned typestate.) Formally:
267 ```
268 forall |'a, ptr| borrowed('a, T.pin(ptr)) -> T.shr('a, ptr)
269 ```
270
271 > This is the final definition of Rust types with pinning.
272
273 Now we have connected the new pinned typestate with both the owned and the shared typestate, so these should be all the axioms we need.
274
275 Next, we define the shared typestate of `PinBox<T>`:
276
277 > **Definition 5: `PinBox<T>.shr`.**
278 A pointer `ptr` and lifetime `'a` satisfy the shared typestate of `PinBox<T>` if `ptr` is a read-only pointer to another pointer `inner_ptr` such that `T.shr('a, inner_ptr)`.
279 In other words, a shared `PinBox<T>` is just a read-only pointer to a shared `T`:
280 ```
281 PinBox<T>.shr('a, ptr) := exists |inner_ptr|
282   ptr.points_to_read_only('a, inner_ptr) && T.shr('a, inner_ptr)
283 ```
284 This requires a way to talk about memory that is read-only for the duration of some lifetime.
285 We assume we have a predicate `ptr.points_to_read_only_bytes('a: Lifetime, bytes: List<Byte>)` saying that `ptr` points to `bytes.len()` many bytes of valid memory containing `bytes`, and that for lifetime `'a`, we are free to read that memory and it will not change.
286 We then define a convenient variant based on higher-level memory representations as usual:
287 ```
288 ptr.points_to_read_only('a: Lifetime, data: U) where List<Bytes>: TryInto<U> :=
289   exists |bytes| bytes.try_into() == Ok(data) && ptr.points_to_read_only_bytes('a, bytes)
290 ```
291
292 Remember that there is an axiom (a) connecting the owned and shared typestate; we have to make sure that this axiom is satisfied for `PinBox`---it turns out that is the case, and the proof relies on the new axiom (c) we just added.
293 With this definition of `PinBox<T>.shr`, justifying the `impl<T> Deref for PinBox<T>` is fairly straight-forward.
294
295 This completes the methods available on `PinBox`.
296 Verifying `Pin` follows the same approach, so I am not going to spell that out here.
297
298 ## Unpin
299
300 The `Unpin` marker trait lets type *opt-out* of pinning: If a type is `Unpin`, the type doesn't actually care about being pinned and hence we can freely convert between `&'a mut T` and `Pin<'a, T>`.
301 Formally speaking:
302
303 > **Definition 6: `Unpin`.** A type `T` is `Unpin` if from `T.pin(ptr)` we can deduce that we own the pointer `ptr` and it points to a list of bytes `bytes` such that `T.own(bytes)` holds.
304 Formally:
305 ```
306 forall |ptr| T.pin(ptr) -> (exists |bytes| ptr.points_to_owned(bytes) && T.own(bytes))
307 ```
308
309 Note that this is exactly the inverse direction of axiom (b) added in definition 2b: For `Unpin` types, we can freely move between the owned and pinned typestate.
310
311 Clearly, `SelfReferential` is *not* `Unpin`.
312 On the other hand, for types like `i32`, their pinned typestate invariant `i32.pin(ptr)` will only care about the memory that `ptr` points to and not about the actual value of `ptr`, so they satisfy the `Unpin` axiom.
313
314 With this definition at hand, it should be clear that if we assume `T: Unpin`, then `&'a mut T` and `Pin<'a, T>` are equivalent types, and so are `Box<T>` and `PinBox<T>`.
315 This justifies all the methods with an `Unpin` bound.
316
317 ## Pin is a Local Extension
318
319 One advantage of this proposal is that it is *local*:
320 Existing types (and new types) that are designed without considering `Pin` remain sound in the presence of this new typestate, even if we automatically derive the `Unpin` trait for these types.
321 The reason this works is that we can always define `T.pin(ptr)` as saying that we fully own `ptr` pointing to `bytes` such that we have `T.own(bytes)`:
322 ```
323 T.pin(ptr) := exists |bytes| ptr.points_to_owned(bytes) && T.own(bytes)
324 ```
325 This satisfies the additional axioms (b) and (c) connecting the pinned typestate to the others, and it also satisfies `Unpin`.
326 The latter is crucial, because it means we can automatically derive `Unpin` instances through the auto trait mechanism and do not have to review the entire ecosystem for `Pin`-compatibility.
327
328 ## Conclusion
329
330 We have seen how the new `Pin` type can be used to give safe APIs to types like `SelfReferential`, and how we can (semi-)formally argue for the correctness of `SelfReferential` and the methods on `Pin` and `PinBox`.
331 I hope I was able to shed some light both on how pinning is useful, and how we can reason about safety of a typed API in general.
332 Next time, we are going to look at an extension to the pinning API proposed by @cramertj which guarantees that `drop` will be called under some circumstances, and how that is useful for intrusive collections.
333
334 Thanks for reading!
335 I am looking forward to hearing your [comments](https://internals.rust-lang.org/t/sharing-for-a-lifetime/7236).
336 In particular, I am curious if the made-up syntax for making the typestate invariants more precise was helpful.