add forum link
[web.git] / ralf / _posts / 2018-11-16-stacked-borrows-implementation.md
1 ---
2 title: "Stacked Borrows Implemented"
3 categories: internship rust
4 forum: https://internals.rust-lang.org/t/stacked-borrows-implemented/8847
5 ---
6
7 Three months ago, I proposed [Stacked Borrows]({% post_url
8 2018-08-07-stacked-borrows %}) as a model for defining what kinds of aliasing
9 are allowed in Rust, and the idea of a [validity invariant]({% post_url
10 2018-08-22-two-kinds-of-invariants %}) that has to be maintained by all code at
11 all times.  Since then I have been busy implementing both of these, and
12 developed Stacked Borrows further in doing so.  This post describes the latest
13 version of Stacked Borrows, and reports my findings from the implementation
14 phase: What worked, what did not, and what remains to be done.  There will also
15 be an opportunity for you to help the effort!
16
17 <!-- MORE -->
18
19 What Stacked Borrows does is that it defines a semantics for Rust programs such
20 that some things about references always hold true for every valid execution
21 (meaning executions where no [undefined behavior]({% post_url
22 2017-07-14-undefined-behavior %}) occurred): `&mut` references are unique (we
23 can rely on no accesses by other functions happening to the memory they point
24 to), and `&` references are immutable (we can rely on no writes happening to the
25 memory they point to, unless there is an `UnsafeCell`).  Usually we have the
26 borrow checker guarding us against such nefarious violations of reference type
27 guarantees, but alas, when we are writing unsafe code, the borrow checker cannot
28 help us.  We have to define a set of rules that makes sense even for unsafe
29 code.
30
31 I will explain these rules again in this post.  The explanation is not going to
32 be the same as last time, not only because it changed a bit, but also because I
33 think I understand the model better myself now so I can do a better job
34 explaining it.
35
36 Ready?  Let's get started.  I hope you brought some time, because this is a
37 rather lengthy post.  If you are not interested in a detailed description of
38 Stacked Borrows, you can skip most of this post and go right to [section 4].  If
39 you only want to know how to help, jump to [section 6].
40
41 ## 1 Enforcing Uniqueness
42
43 Let us first ignore the part about `&` references being immutable and focus on
44 uniqueness of mutable references.  Namely, we want to define our model in a way
45 that calling the following function will trigger undefined behavior:
46
47 {% highlight rust %}
48 fn demo0() {
49   let x = &mut 1u8;
50   let y = &mut *x;
51   *y = 5;
52   // Write through a pointer aliasing `y`
53   *x = 3;
54   // Use `y` again, asserting it is still exclusive
55   let _val = *y;
56 }
57 {% endhighlight %}
58
59 We want this function to be disallowed because between two uses of `y`, there is
60 a use of another pointer for the same location, violating the fact that `y`
61 should be unique.
62
63 Notice that this function does not compile, the borrow checker won't allow it.
64 That's great!  It is undefined behavior, after all.  But the entire point of
65 this exercise is to explain *why* we have undefined behavior here *without*
66 referring to the borrow checker, because we want to have rules that also work
67 for unsafe code.  In fact, you could say that retroactively, these rules explain
68 why the borrow checker works the way it does:  We can pretend that the model came
69 first, and the borrow checker is merely doing compile-time checks to make sure
70 we follow the rules of the model.
71
72 To be able to do this, we have to pretend our machine has two things which real
73 CPUs do not have.  This is an example of adding "shadow state" or "instrumented
74 state" to the "virtual machine" that we [use to specify Rust]({% post_url
75 2017-06-06-MIR-semantics %}).  This is not an uncommon approach, often times
76 source languages make distinctions that do not appear in the actual hardware.  A
77 related example is
78 [valgrind's memcheck](http://valgrind.org/docs/manual/mc-manual.html) which
79 keeps track of which memory is initialized to be able to detect memory errors:
80 During a normal execution, uninitialized memory looks just like all other
81 memory, but to figure out whether the program is violating C's memory rules, we
82 have to keep track of some extra state.
83
84 For stacked borrows, the extra state looks as follows:
85
86 1. For every pointer, we keep track of an extra "tag" that records when and how
87    this pointer was created.
88 2. For every location in memory, we keep track of a stack of "items", indicating
89    which tag a pointer must have to be allowed to access this location.
90
91 These exist separately, i.e., when a pointer is stored in memory, then we both
92 have a tag stored as part of this pointer value (remember,
93 [bytes are more than `u8`]({% post_url 2018-07-24-pointers-and-bytes %})), and
94 every byte occupied by the pointer has a stack regulating access to this
95 location.  Also these two do not interact, i.e., when loading a pointer from
96 memory, we just load the tag that was stored as part of this pointer.  The stack
97 of a location, and the tag of a pointer stored at some location, do not have any
98 effect on each other.
99
100 In our example, there are two pointers (`x` and `y`) and one location of
101 interest (the one both of these pointers point to, initialized with `1u8`).
102 When we initially create `x`, it gets tagged `Uniq(0)` to indicate that it is a
103 unique reference, and the location's stack has `Uniq(0)` at its top to indicate
104 that this is the latest reference allowed to access said location.  When we
105 create `y`, it gets a new tag, `Uniq(1)`, so that we can distinguish it from
106 `x`.  We also push `Uniq(1)` onto the stack, indicating not only that `Uniq(1)`
107 is the latest reference allow to access, but also that it is "derived from"
108 `Uniq(0)`: The tags higher up in the stack are descendants of the ones further
109 down.
110
111 So after both references are created, we have: `x` tagged `Uniq(0)`, `y` tagged
112 `Uniq(1)`, and the stack contains `[Uniq(0), Uniq(1)]`. (Top of the stack is on
113 the right.)
114
115 When we use `y` to access the location, we make sure its tag is at the top of
116 the stack: check, no problem here.  When we use `x`, we do the same thing: Since
117 it is not at the top yet, we pop the stack until it is, which is easy.  Now the
118 stack is just `[Uniq(0)]`.  Now we use `y` again and... blast!  Its tag is not
119 on the stack.  We have undefined behavior.
120
121 In case you got lost, here is the source code with comments indicating the tags
122 and the stack of the one location that interests us:
123
124 {% highlight rust %}
125 fn demo0() {
126   let x = &mut 1u8; // tag: `Uniq(0)`
127   // stack: [Uniq(0)]
128
129   let y = &mut *x; // tag: `Uniq(1)`
130   // stack: [Uniq(0), Uniq(1)]
131
132   // Pop until `Uniq(1)`, the tag of `y`, is on top of the stack:
133   // Nothing changes.
134   *y = 5;
135   // stack: [Uniq(0), Uniq(1)]
136
137   // Pop until `Uniq(0)`, the tag of `x`, is on top of the stack:
138   // We pop `Uniq(1)`.
139   *x = 3;
140   // stack: [Uniq(0)]
141
142   // Pop until `Uniq(1)`, the tag of `y`, is on top of the stack:
143   // That is not possible, hence we have undefined behavior.
144   let _val = *y;
145 }
146 {% endhighlight %}
147
148 Well, actually having undefined behavior here is good news, since that's what we
149 wanted from the start!  And since there is an implementation of the model in
150 [miri](https://github.com/solson/miri/), you can try this yourself: The amazing
151 @shepmaster has integrated miri into the playground, so you can
152 [put the example there](https://play.rust-lang.org/?version=stable&mode=debug&edition=2015&gist=d15868687f79072688a0d0dd1e053721)
153 (adjusting it slightly to circumvent the borrow checker), then select "Tools -
154 Miri" and it will complain (together with a rather unreadable backtrace, we sure
155 have to improve that one):
156
157 ```
158 error[E0080]: constant evaluation error: Borrow being dereferenced (Uniq(1037)) does not exist on the stack
159  --> src/main.rs:6:14
160   |
161 6 |   let _val = *y;
162   |              ^^ Borrow being dereferenced (Uniq(1037)) does not exist on the stack
163   |
164 ```
165
166 ## 2 Enabling Sharing
167
168 If we just had unique pointers, Rust would be a rather dull language.  Luckily
169 enough, there are also two ways to have shared access to a location: through
170 shared references (safely), and through raw pointers (unsafely).  Moreover,
171 shared references *sometimes* (but not when they point to an `UnsafeCell`)
172 assert an additional guarantee: Their destination is immutable.
173
174 For example, we want the following code to be allowed -- not least because this
175 is actually safe code accepted by the borrow checker, so we better make sure
176 this is not undefined behavior:
177
178 {% highlight rust %}
179 fn demo1() {
180   let x = &mut 1u8;
181   // Create several shared references, and we can also still read from `x`
182   let y1 = &*x;
183   let _val = *x;
184   let y2 = &*x;
185   let _val = *y1;
186   let _val = *y2;
187 }
188 {% endhighlight %}
189
190 However, the following code is *not* okay:
191
192 {% highlight rust %}
193 fn demo2() {
194   let x = &mut 1u8;
195   let y = &*x;
196   // Create raw reference aliasing `y` and write through it
197   let z = x as *const u8 as *mut u8;
198   unsafe { *z = 3; }
199   // Use `y` again, asserting it still points to the same value
200   let _val = *y;
201 }
202 {% endhighlight %}
203
204 If you
205 [try this in miri](https://play.rust-lang.org/?version=stable&mode=debug&edition=2015&gist=1bc8c2f432941d02246fea0808e2e4f4),
206 you will see it complain:
207
208 ```
209  --> src/main.rs:6:14
210   |
211 6 |   let _val = *y;
212   |              ^^ Location is not frozen long enough
213   |
214 ```
215
216 How is it doing that, and what is a "frozen" location?
217
218 To explain this, we have to extend the "shadow state" of our "virtual machine" a
219 bit.  First of all, we introduce a new kind of tag that a pointer can carry: A
220 *shared* tag.  The following Rust type describes the possible tags of a pointer:
221
222 {% highlight rust %}
223 pub type Timestamp = u64;
224 pub enum Borrow {
225     Uniq(Timestamp),
226     Shr(Option<Timestamp>),
227 }
228 {% endhighlight %}
229
230 You can think of the timestamp as a unique ID, but as we will see, for shared
231 references, it is also important to be able to determine which of these IDs was
232 created first.  The timestamp is optional in the shared tag because that tag is
233 also used by raw pointers, and for raw pointers, we are often not able to track
234 when and how they are created (for example, when raw pointers are converted to
235 integers and back).
236
237 We use a separate type for the items on our stack, because there we do not need
238 a timestamp for shared pointers:
239
240 {% highlight rust %}
241 pub enum BorStackItem {
242     Uniq(Timestamp),
243     Shr,
244 }
245 {% endhighlight %}
246
247 And finally, a "borrow stack" consists of a stack of `BorStackItem`, together
248 with an indication of whether the stack (and the location it governs) is
249 currently *frozen*, meaning it may only be read, not written:
250
251 {% highlight rust %}
252 pub struct Stack {
253     borrows: Vec<BorStackItem>, // used as a stack; never empty
254     frozen_since: Option<Timestamp>, // virtual frozen "item" on top of the stack
255 }
256 {% endhighlight %}
257
258 ### 2.1 Executing the Examples
259
260 Let us now look at what happens when we execute our two example programs.  To
261 this end, I will embed comments in the source code.  There is only one location
262 of interest here, so whenever I talk about a "stack", I am referring to the
263 stack of that location.
264
265 {% highlight rust %}
266 fn demo1() {
267   let x = &mut 1u8; // tag: `Uniq(0)`
268   // stack: [Uniq(0)]; not frozen
269   
270   let y1 = &*x; // tag: `Shr(Some(1))`
271   // stack: [Uniq(0), Shr]; frozen since 1
272
273   // Access through `x`.  We first check whether its tag `Uniq(0)` is in the
274   // stack (it is).  Next, we make sure that either our item *or* `Shr` is on
275   // top *or* the location is frozen.  The latter is the case, so we go on.
276   let _val = *x;
277   // stack: [Uniq(0), Shr]; frozen since 1
278
279   // This is not an access, but we still dereference `x`, so we do the same
280   // actions as on a read.  Just like in the previous line, nothing happens.
281   let y2 = &*x; // tag: `Shr(Some(2))`
282   // stack: [Uniq(0), Shr]; frozen since 1
283
284   // Access through `y1`.  Since the shared tag has a timestamp (1) and the type
285   // (`u8`) does not allow interior mutability (no `UnsafeCell`), we check that
286   // the location is frozen since (at least) that timestamp.  It is.
287   let _val = *y1;
288   // stack: [Uniq(0), Shr]; frozen since 1
289
290   // Same as with `y2`: The location is frozen at least since 2 (actually, it
291   // is frozen since 1), so we are good.
292   let _val = *y2;
293   // stack: [Uniq(0), Shr]; frozen since 1
294 }
295 {% endhighlight %}
296
297 This example demonstrates a few new aspects.  First of all, there are actually
298 two operations that perform tag-related checks in this model (so far):
299 Dereferencing a pointer (whenever you have a `*`, also implicitly), and actual
300 memory accesses.  Operations like `&*x` are an example of operations that
301 dereference a pointer without accessing memory.  Secondly, *reading* through a
302 mutable reference is actually okay *even when that reference is not exclusive*.
303 It is only *writing* through a mutable reference that "re-asserts" its
304 exclusivity.  I will come back to these points later, but let us first go
305 through another example.
306
307 {% highlight rust %}
308 fn demo2() {
309   let x = &mut 1u8; // tag: `Uniq(0)`
310   // stack: [Uniq(0)]; not frozen
311   
312   let y = &*x; // tag: `Shr(Some(1))`
313   // stack: [Uniq(0), Shr]; frozen since 1
314
315   // The `x` here really is a `&*x`, but we have already seen above what
316   // happens: `Uniq(0)` must be in the stack, but we leave it unchanged.
317   let z = x as *const u8 as *mut u8; // tag irrelevant because raw
318   // stack: [Uniq(0), Shr]; frozen since 1
319
320   // A write access through a raw pointer: Unfreeze the location and make sure
321   // that `Shr` is at the top of the stack.
322   unsafe { *z = 3; }
323   // stack: [Uniq(0), Shr]; not frozen
324
325   // Access through `y`.  There is a timestamp in the `Shr` tag, and the type
326   // `u8` does not allow interior mutability, but the location is not frozen.
327   // This is undefined behavior.
328   let _val = *y;
329 }
330 {% endhighlight %}
331
332 ### 2.2 Dereferencing a Pointer
333 [section 2.2]: #22-dereferencing-a-pointer
334
335 As we have seen, we consider the tag of a pointer already when dereferencing it,
336 before any memory access happens.  The operation on a dereference never mutates
337 the stack, but it performs some basic checks that might declare the program UB.
338 The reason for this is twofold: First of all, I think we should require some
339 basic validity for pointers that are dereferenced even when they do not access
340 memory. Secondly, there is the practical concern for the implementation in miri:
341 When we dereference a pointer, we are guaranteed to have type information
342 available (crucial for things that depend on the presence of an `UnsafeCell`),
343 whereas having type information on every memory access would be quite hard to
344 achieve in miri.
345
346 Notice that on a dereference, we have *both* a tag at the pointer *and* the type
347 of a pointer, and the two might not agree, which we do not always want to rule
348 out (after a `transmute`, we might have raw or shared pointers with a unique
349 tag, for example).
350
351 The following checks are done on every pointer dereference, for every location
352 covered by the pointer (`size_of_val` tells us how many bytes the pointer
353 covers):
354
355 1. If this is a raw pointer, do nothing and reset the tag used for the access to
356    `Shr(None)`.  Raw accesses are checked as little as possible.
357 2. If this is a unique reference and the tag is `Shr(Some(_))`, that's an error.
358 3. If the tag is `Uniq`, make sure there is a matching `Uniq` item with the same
359    ID on the stack.
360 4. If the tag is `Shr(None)`, make sure that either the location is frozen or
361    else there is a `Shr` item on the stack.
362 5. If the tag is `Shr(Some(t))`, then the check depends on whether the location
363    is inside an `UnsafeCell` or not, according to the type of the reference.
364     - Locations outside `UnsafeCell` must have `frozen_since` set to `t` or an
365       older timestamp.
366     - `UnsafeCell` locations must either be frozen or else have a `Shr` item in
367       their stack (same check as if the tag had no timestamp).
368
369 ### 2.3 Accessing Memory
370 [section 2.3]: #23-accessing-memory
371
372 On an actual memory access, we know the tag of the pointer that was used to
373 access (unless it was a raw pointer, in which case the tag we see is
374 `Shr(None)`), and we know whether we are reading from or writing to the current
375 location.  We perform the following operations on all locations affected by the
376 access:
377
378 1. If the location is frozen and this is a read access, nothing happens (even
379    if the tag is `Uniq`).
380 2. Unfreeze the location (set `frozen_since` to `None`).  Either the location is
381    already unfrozen, or this is a write.
382 3. Pop the stack until the top item matches the tag of the pointer.
383     - A `Uniq` item matches a `Uniq` tag with the same ID.
384     - A `Shr` item matches any `Shr` tag (with or without timestamp).
385     - When we are reading, a `Shr` item matches a `Uniq` tag.
386
387     If we pop the entire stack without finding a match, then we have undefined
388     behavior.
389
390 To understand these rules better, try going back through the three examples we
391 have seen so far and applying these rules for dereferencing pointers and
392 accessing memory to understand how they interact.
393
394 The most subtle point here is that we make a `Uniq` tag match a `Shr` item and
395 also accept `Uniq` reads on frozen locations.  This is required to make `demo1`
396 work: Rust permits read accesses through mutable references even when they are
397 not currently actually unique.  Our model hence has to do the same.
398
399 ## 3 Retagging and Creating Raw Pointers
400
401 We have talked quite a bit about what happens when we *use* a pointer.  It is
402 time we take a close look at *how pointers are created*.  However, before we go
403 there, I would like us to consider one more example:
404
405 {% highlight rust %}
406 fn demo3(x: &mut u8) -> u8 {
407     some_function();
408     *x
409 }
410 {% endhighlight %}
411
412 The question is: Can we move the load of `x` to before the function call?
413 Remember that the entire point of Stacked Borrows is to enforce a certain
414 discipline when using references, in particular, to enforce uniqueness of
415 mutable references.  So we should hope that the answer to that question is "yes"
416 (and that, in turn, is good because we might use it for optimizations).
417 Unfortunately, things are not so easy.
418
419 The uniqueness of mutable references entirely rests on the fact that the pointer
420 has a unique tag: If our tag is at the top of the stack (and the location is not
421 frozen), then any access with another tag will pop our item from the stack (or
422 cause undefined behavior).  This is ensured by the memory access checks.  Hence,
423 if our tag is *still* on the stack after some other accesses happened (and we
424 know it is still on the stack every time we dereference the pointer, as per the
425 dereference checks described above), we know that no access through a pointer
426 with a different tag can have happened.
427
428 ### 3.1 Guaranteed Freshness
429
430 However, what if `some_function` has an exact copy of `x`?  We got `x` from our
431 caller (whom we do not trust), maybe they used that same tag for another
432 reference (copied it with `transmute_copy` or so) and gave that to
433 `some_function`?  There is a simple way we can circumvent this concern: Generate
434 a new tag for `x`.  If *we* generate the tag (and we know generation never emits
435 the same tag twice, which is easy), we can be sure this tag is not used for any
436 other reference.  So let us make this explicit by putting a `Retag` instruction
437 into the code where we generate new tags:
438
439 {% highlight rust %}
440 fn demo3(x: &mut u8) -> u8 {
441     Retag(x);
442     some_function();
443     *x
444 }
445 {% endhighlight %}
446
447 These `Retag` instructions are inserted by the compiler pretty much any time
448 references are copied: At the beginning of every function, all inputs of
449 reference type get retagged.  On every assignment, if the assigned value is of
450 reference type, it gets retagged.  Moreover, we do this even when the reference
451 value is inside the field of a `struct` or `enum`, to make sure we really cover
452 all references.  (This recursive descent is already implemented, but the
453 implementation has not landed yet.)  However, we do *not* descend recursively
454 through references: Retagging a `&mut &mut u8` will only retag the *outer*
455 reference.
456
457 Retagging is the *only* operation that generates fresh tags.  Taking a reference
458 simply forwards the tag of the pointer we are basing this reference on.
459
460 Here is our very first example with explicit retagging:
461
462 {% highlight rust %}
463 fn demo0() {
464   let x = &mut 1u8; // nothing interesting happens here
465   Retag(x); // tag of `x` gets changed to `Uniq(0)`
466   // stack: [Uniq(0)]; not frozen
467   
468   let y = &mut *x; // nothing interesting happens here
469   Retag(y); // tag of `y` gets changed to `Uniq(1)`
470   // stack: [Uniq(0), Uniq(1)]; not frozen
471
472   // Check that `Uniq(1)` is on the stack, then pop to bring it to the top.
473   *y = 5;
474   // stack: [Uniq(0), Uniq(1)]; not frozen
475
476   // Check that `Uniq(0)` is on the stack, then pop to bring it to the top.
477   *x = 3;
478   // stack: [Uniq(0)]; not frozen
479
480   // Check that `Uniq(1)` is on the stack -- it is not, hence UB.
481   let _val = *y;
482 }
483 {% endhighlight %}
484
485 For each reference, `Retag` does the following (we will slightly refine these
486 instructions later) on all locations covered by the reference (again, according
487 to `size_of_val`):
488
489 1. Compute a fresh tag, `Uniq(_)` for a mutable reference and `Shr(Some(_))` for
490    a shared reference.
491 2. Perform the checks that would also happen when we dereference this reference.
492 3. Perform the actions that would also happen when an actual access happens
493    through this reference (for shared references a read access, for mutable
494    references a write access).
495 4. If the new tag is `Uniq`, push it onto the stack.  (The location cannot be
496    frozen: `Uniq` tags are only created for mutable references, and we just
497    performed the actions of a write access to memory, which unfreezes
498    locations.)
499 5. If the new tag is `Shr`:
500     - If the location is already frozen, we do nothing.
501     - Otherwise:
502       1. Push a `Shr` item to the stack.
503       2. If the location is outside of `UnsafeCell`, it gets frozen with the
504          timestamp of the new reference.
505
506 One high-level way to think about retagging is that it computes a fresh tag, and
507 then performs a reborrow of the old reference with the new tag.
508
509 ### 3.2 When Pointers Escape
510
511 Creating a shared reference is not the only way to share a location: We can also
512 create raw pointers, and if we are careful enough, use them to access a location
513 from different aliasing pointers.  (Of course, "careful enough" is not very
514 precise, but the precise answer is the very model I am describing here.)
515
516 To account for this, we need one final ingredient in our model: a special
517 instruction that indicates that a reference was cast to a raw pointer, and may
518 thus be accessed from these raw pointers in a shared way.  Consider the
519 [following example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2015&gist=253868e96b7eba85ef28e1eabd557f66):
520
521 {% highlight rust %}
522 fn demo4() {
523   let x = &mut 1u8;
524   Retag(x); // tag of `x` gets changed to `Uniq(0)`
525   // stack: [Uniq(0)]; not frozen
526
527   // Make sure what `x` points to is accessible through raw pointers.
528   EscapeToRaw(x);
529   // stack: [Uniq(0), Shr]; not frozen
530   
531   let y1 = x as *mut u8;
532   let y2 = y1;
533   unsafe {
534     // All of these first dereference a raw pointer (no checks, tag gets
535     // ignored) and then perform a read or write access with `Shr(None)` as
536     // the tag, which is already the top of the stack so nothing changes.
537     *y1 = 3;
538     *y2 = 5;
539     *y2 = *y1;
540   }
541
542   // Writing to `x` again pops `Shr` off the stack, as per the rules for
543   // write accesses.
544   *x = 7;
545   // stack: [Uniq(0)]; not frozen
546
547   // Any further access through the raw pointers is undefined behavior, even
548   // reads: The write to `x` re-asserted that `x` is the unique reference for
549   // this memory.
550   let _val = unsafe { *y1 };
551 }
552 {% endhighlight %}
553
554 The behavior of `EscapeToRaw` is best described as "reborrowing for a raw
555 pointer": The steps are the same as for `Retag` above, except that the new
556 pointer's tag is `Shr(None)` and we do not freeze (i.e., we behave as if the
557 entire pointee was inside an `UnsafeCell`).
558
559 Knowing about both `Retag` and `EscapeToRaw`, you can now go back to `demo2` and
560 should be able to fully explain why the stack changes the way it does in that
561 example.
562
563 ### 3.3 The Case of the Aliasing References
564
565 Everything I described so far was pretty much in working condition as of about a
566 week ago.  However, there was one thorny problem that I only discovered fairly
567 late, and as usual it is best demonstrated by an example -- entirely in safe
568 code:
569
570 {% highlight rust %}
571 fn demo_refcell() {
572   let rc = &mut RefCell::new(23u8);
573   Retag(rc); // tag gets changed to `Uniq(0)`
574   // We will consider the stack of the location where `23` is stored; the
575   // `RefCell` bookkeeping counters are not of interest.
576   // stack: [Uniq(0)]
577
578   // Taking a shared reference shares the location but does not freeze, due
579   // to the `UnsafeCell`.
580   let rc_shr = &*rc;
581   Retag(rc_shr); // tag gets changed to `Shr(Some(1))`
582   // stack: [Uniq(0), Shr]; not frozen
583
584   // Lots of stuff happens here but it does not matter for this example.
585   let mut bmut = rc_shr.borrow_mut();
586   
587   // Obtain a mutable reference into the `RefCell`.
588   let mut_ref = &mut *bmut;
589   Retag(mut_ref); // tag gets changed to `Uniq(2)`
590   // stack: [Uniq(0), Shr, Uniq(2)]; not frozen
591   
592   // And at the same time, a fresh shared reference to its outside!
593   // This counts as a read access through `rc`, so we have to pop until
594   // at least a `Shr` is at the top of the stack.
595   let shr_ref = &*rc; // tag gets changed to `Shr(Some(3))`
596   Retag(shr_ref);
597   // stack: [Uniq(0), Shr]; not frozen
598
599   // Now using `mut_ref` is UB because its tag is no longer on the stack.  But
600   // that is bad, because it is usable in safe code.
601   *mut_ref += 19;
602 }
603 {% endhighlight %}
604
605 Notice how `mut_ref` and `shr_ref` alias!  And yet, creating a shared reference
606 to the memory already covered by our unique `mut_ref` must not invalidate
607 `mut_ref`.  If we follow the instructions above, when we retag `shr_ref` after
608 it got created, we have no choice but pop the item matching `mut_ref` off the
609 stack.  Ouch.
610
611 This made me realize that creating a shared reference has to be very weak inside
612 `UnsafeCell`.  In fact, it is entirely equivalent to `EscapeToRaw`: We just have
613 to make sure some kind of shared access is possible, but we have to accept that
614 there might be active mutable references assuming exclusive access to the same
615 locations.  That on its own is not enough, though.
616
617 I also added a new check to the retagging procedure: Before taking any action
618 (i.e., before step 3, which could pop items off the stack), we check if the
619 reborrow is redundant: If the new reference we want to create is already
620 dereferencable (because its item is already on the stack and, if applicable, the
621 stack is already frozen), *and* if the item that justifies this is moreover
622 "derived from" the item that corresponds to the old reference, then we just do
623 nothing.  Here, "derived from" means "further up the stack".  Basically, the
624 reborrow has already happened and the new reference is ready for use; *and*
625 because of that "derived from" check, we know that using the new reference will
626 *not* pop the item corresponding to the old reference off the stack.  In that
627 case, we avoid popping anything, to keep other references valid.
628
629 It may seem like this rule can never apply, because how can our fresh tag match
630 something that's already on the stack?  This is indeed impossible for `Uniq`
631 tags, but for `Shr` tags, matching is more liberal.  For example, this rule
632 applies in our example above when we create `shr_ref` from `mut_ref`.  We do not
633 require freezing (because there is an `UnsafeCell`), there is already a `Shr` on
634 the stack (so the new reference is dereferencable) and the item matching the old
635 reference (`Uniq(0)`) is below that `Shr` (so after using the new reference, the
636 old one remains dereferencable).  Hence we do nothing, keeping the `Uniq(2)` on
637 the stack, such that the access through `mut_ref` at the end remains valid.
638
639 This may sound like a weird rule, and it is.  I would surely not have thought of
640 this if `RefCell` would not force our hands here.  However, as we shall see in
641 [section 5], it also does not to break any of the important properties of the
642 model (mutable references being unique and shared references being immutable
643 except for `UnsafeCell`).  Moreover, when pushing an item to the stack (at the
644 end of the retag action), we can now be sure that the stack is not yet frozen:
645 if it were frozen, the reborrow would be redundant.
646
647 With this extension, the instructions for retagging and `EscapeToRaw` now look
648 as follows (again executed on all locations covered by the reference, according
649 to `size_of_val`):
650
651 1. Compute a fresh tag: `Uniq(_)` for a mutable reference, `Shr(Some(_))` for a
652    shared reference, `Shr(None)` if this is `EscapeToRaw`.
653 2. Perform the checks that would also happen when we dereference this reference.
654    Remember the position of the item matching the tag in the stack.
655 3. Redundancy check: If the new tag passes the checks performed on a
656    dereference, and if the item that makes this check succeed is *above* the one
657    we remembered in step 2 (where the "frozen" state is considered above every
658    item in the stack), then we stop.  We are done for this location.
659 4. Perform the actions that would also happen when an actual access happens
660    through this reference (for shared references a read access, for mutable
661    references a write access).<br>
662    Now the location cannot be frozen any more: If the fresh tag is `Uniq`, we
663    just unfroze; if the fresh tag is `Shr` and the location was already frozen,
664    then the redundancy check (step 3) would have kicked in.
665 5. If the new tag is `Uniq`, push it onto the stack.
666 6. If the new tag is `Shr`, push a `Shr` item to the stack.  Then, if the
667    location is outside of `UnsafeCell`, it gets frozen with the timestamp of the
668    new reference.
669
670 The one thing I find slightly unsatisfying about the redundancy check is that it
671 seems to overlap a bit with the rule that on a *read* access, a `Shr` item
672 matches a `Uniq` tag.  Both of these together enable the read-only use of
673 mutable references that have already been shared; I would prefer to have a
674 single condition enabling that instead of two working together.  Still, overall
675 I think this is a pleasingly clean model; certainly much cleaner than what I
676 proposed last year and at the same time much more compatible with existing code.
677
678 ## 4 Differences to the Original Proposal
679 [section 4]: #4-differences-to-the-original-proposal
680
681 The key differences to the original proposal is that the check performed on a
682 dereference, and the check performed on an access, are not the same check.  This
683 means there are more "moving parts" in the model, but it also means we do not
684 need a weird special exception (about reads from frozen locations) for `demo1`
685 any more like the original proposal did.  The main reason for this change,
686 however, is that on an access, we just do not know if we are inside an
687 `UnsafeCell` or not, so we cannot do all the checks we would like to do.
688 Accordingly, I also rearranged terminology a bit.  There is no longer one
689 "reactivation" action, instead there is a "deref" check and an "access" action,
690 as described above in sections [2.2][section 2.2] and [2.3][section 2.3].
691
692 Beyond that, I made the behavior of shared references and raw pointers more
693 uniform.  This helped to fix test failures around `iter_mut` on slices, which
694 first creates a raw reference and then a shared reference: In the original
695 model, creating the shared reference invalidates previously created raw
696 pointers.  As a result of the more uniform treatment, this no longer happens.
697 (Coincidentally, I did not make this change with the intention of fixing
698 `iter_mut`.  I did this change because I wanted to reduce the number of case
699 distinctions in the model.  Then I realized the relevant test suddenly passed
700 even with the full model enabled, investigated what happened, and realized I
701 accidentally had had a great idea. :D )
702
703 The tag is now "typed" (`Uniq` vs `Shr`) to be able to support `transmute`
704 between references and shared pointers.  Such `transmute` were an open question
705 in the original model and some people raised concerns about it in the ensuing
706 discussion.  I invite all of you to come up with strange things you think you
707 should be able to `transmute` and throw them at miri so that we can see if your
708 use-cases are covered. :)
709
710 Creating a shared reference now always pushes a `Shr` item onto the stack, even
711 when there is no `UnsafeCell`. This means that starting with a mutable reference
712 `x`, `&*x as *const _ as *mut _` is pretty much equivalent to `x as *mut _`; the
713 fact that we have an intermediate shared reference does not matter (not for the
714 aliasing model, anyway).  During the implementation, I realized that in `x as
715 *const _` on a mutable reference, `x` actually first gets coerced to shared
716 reference, which then gets cast to a raw pointer.  This happens in
717 `NonNull::from`, so if you later write to that `NonNull`, you end up writing to
718 a raw pointer that was created from a shared reference.  Originally I intended
719 this to be strictly illegal.  This is writing to a shared reference after all,
720 how dare you!  However, it turns out it's actually no big deal *if the shared
721 reference does not get used again later*.  This is an access-based model after
722 all, if a reference never gets used again we do not care much about enforcing
723 any guarantees for it.  (This is another example of a coincidental fix, where I
724 had a surprisingly passing test case and then investigated what happened.)
725
726 The redundancy check during retagging can be seen as refining a similar check
727 that the original model did whenever a new reference was created (where we
728 wouldn't change the state if the new borrow is already active).
729
730 Finally, the notion of "function barriers" from the original Stacked Borrows has
731 not been implemented yet.  This is the next item on my todo list.
732
733 ## 5 Key Properties
734 [section 5]: #5-key-properties
735
736 Let us look at the two key properties that I set out as design goals, and see
737 how the model guarantees that they hold true in all valid (UB-free) executions.
738
739 ### 5.1 Mutable References are Unique
740
741 The property I would like to establish here is that: After creating (retagging,
742 really) a `&mut`, if we then run some unknown code *that does not get passed the
743 reference*, and then we use the reference again (reading or writing), we can be
744 sure that this unknown code did not access the memory behind our mutable
745 reference at all (or we have UB).  For example:
746
747 {% highlight rust %}
748 fn demo_mut_unique(our: &mut i32) -> i32 {
749   Retag(our); // So we can be sure the tag is unique
750
751   *our = 5;
752
753   unknown_code();
754
755   // We know this will return 5, and moreover if `unknown_code` does not panic
756   // we know we could do the write after calling `unknown_code` (because it
757   // cannot even read from `our`).
758   *our
759 }
760 {% endhighlight %}
761
762 The proof sketch goes as follows: After retagging the reference, we know it is
763 at the top of the stack and the location is not frozen.  (The "redundant
764 reborrow" rule does not apply because a fresh `Uniq` tag can never be
765 redundant.)  For any access performed by the unknown code, we know that access
766 cannot use the tag of our reference because the tags are unique and not
767 forgeable.  Hence if the unknown code accesses our locations, that would pop our
768 tag from the stack.  When we use our reference again, we know it is on the
769 stack, and hence has not been popped off.  Thus there cannot have been an access
770 from the unknown code.
771
772 Actually this theorem applies *any time* we have a reference whose tag we can be
773 sure has not been leaked to anyone else, and which points to locations which
774 have this tag at the top of the (unfrozen) stack.  This is not just the case
775 immediately after retagging.  We know our reference is at the top of the stack
776 after writing to it, so in the following example we know that `unknown_code_2`
777 cannot access `our`:
778
779 {% highlight rust %}
780 fn demo_mut_advanced_unique(our: &mut u8) -> u8 {
781   Retag(our); // So we can be sure the tag is unique
782
783   unknown_code_1(&*our);
784
785   // This "re-asserts" uniqueness of the reference: After writing, we know
786   // our tag is at the top of the stack.
787   *our = 5;
788
789   unknown_code_2();
790
791   // We know this will return 5
792   *our
793 }
794 {% endhighlight %}
795
796 ### 5.2 Shared References (without `UnsafeCell)` are Immutable
797
798 The key property of shared references is that: After creating (retagging,
799 really) a shared reference, if we then run some unknown code (it can even have
800 our reference if it wants), and then we use the reference again, we know that
801 the value pointed to by the reference has not been changed.  For example:
802
803 {% highlight rust %}
804 fn demo_shr_frozen(our: &u8) -> u8 {
805   Retag(our); // So we can be sure the tag actually carries a timestamp
806
807   // See what's in there.
808   let val = *our;
809   
810   unknown_code(our);
811
812   // We know this will return `val`
813   *our
814 }
815 {% endhighlight %}
816
817 The proof sketch goes as follows: After retagging the reference, we know the
818 location is frozen (this is the case even if the "redundant reborrow" rule
819 applies).  If the unknown code does any write, we know this will unfreeze the
820 location.  The location might get re-frozen, but only at the then-current
821 timestamp.  When we do our read after coming back from the unknown code, this
822 checks that the location is frozen *at least* since the timestamp given in its
823 tag, so if the location is unfrozen or got re-frozen by the unknown code, the
824 check would fail.  Thus the unknown code cannot have written to the location.
825
826 One interesting observation here for both of these proofs is that all we rely on
827 when the unknown code is executed are the actions performed on every memory
828 access.  The additional checks that happen when a pointer is dereferenced only
829 matter in *our* code, not in the foreign code.  Hence we have no problem
830 reasoning about the case where we call some code via FFI that is written in a
831 language without a notion of "dereferencing", all we care about is the actual
832 memory accesses performed by that foreign code.  This also indicates that we
833 could see the checks on pointer dereference as another "shadow state operation"
834 next to `Retag` and `EscapeToRaw`, and then these three operations plus the
835 actions on memory accesses are all that there is to Stacked Borrows.  This is
836 difficult to implement in miri because dereferences can happen any time a path
837 is evaluated, but it is nevertheless interesting and might be useful in a
838 "lower-level MIR" that does not permit dereferences in paths.
839
840 ## 6 Evaluation, and How You Can Help
841 [section 6]: #6-evaluation-and-how-you-can-help
842
843 I have implemented both the validity invariant and the model as described above
844 in miri. This [uncovered](https://github.com/rust-lang/rust/issues/54908) two
845 [issues](https://github.com/rust-lang/rust/issues/54957) in the standard
846 library, but both were related to validity invariants, not Stacked Borrows.
847 With these exceptions, the model passes the entire test suite.  There were some
848 more test failures in earlier versions (as mentioned in [section 4]), but the
849 final model accepts all the code covered by miri's test suite.  (If you look
850 close enough, you can see that three libstd methods are currently whitelisted
851 and what they do is not checked.  However, even before I ran into these cases,
852 [efforts](https://github.com/rust-lang/rust/pull/54668) were already
853 [underway](https://github.com/rust-lang/rfcs/pull/2582) that would fix all of
854 them, so I am not concerned about them.)  Moreover I wrote a bunch of
855 compile-fail tests to make sure the model catches various violations of the key
856 properties it should ensure.
857
858 I am quite happy with this!  I was expecting much more trouble, expecting to run
859 into cases where libstd does strange things that are common or otherwise hard to
860 declare illegal and that my model could not reasonably allow.  I see the test
861 suite passing as an indication that this model may be well-suited for Rust.
862
863 However, miri's test suite is tiny, and I have but one brain to come up with
864 counterexamples!  In fact I am quite a bit worried because I literally came up
865 with `demo_refcell` less than two weeks ago, so what else might I have missed?
866 This where you come in.  Please test this model!  Come up with something funny
867 you think should work (I am thinking about funny `transmute` in particular,
868 using type punning through unions or raw pointers if you prefer that), or maybe
869 you have some crate that has some unsafe code and a test suite (you do have a
870 test suite, right?) that might run under miri.
871
872 The easiest way to try the model is the
873 [playground](https://play.rust-lang.org/): Type the code, select "Tools - Miri",
874 and you'll see what it does.
875
876 For things that are too long for the playground, you have to install miri on
877 your own computer.  miri depends on rustc nightly and has to be updated
878 regularly to keep working, so it is not well-suited for crates.io.  Instead,
879 installation instructions for miri are provided
880 [in the README](https://github.com/solson/miri/#running-miri).  We are still
881 working on making installing miri easier.  Please let me know if you are having
882 trouble with anything.  You can report issues, comment on this post or find me
883 in chat (as of recently, I am partial to Zulip where we have an
884 [unsafe code guidelines stream](https://rust-lang.zulipchat.com/#narrow/stream/136281-wg-unsafe-code-guidelines)).
885
886 With miri installed, you can `cargo miri` a project with a binary to run it in
887 miri.  Dependencies should be fully supported, so you can use any crate you
888 like.  It is not unlikely, however, that you will run into issues because miri
889 does not support some operation.  In that case please search the
890 [issue tracker](https://github.com/solson/miri/issues) and report the issue if
891 it is new.  We cannot support everything, but we might be able to do something
892 for your case.
893
894 Unfortunately, `cargo miri test` is currently broken; if you want to help with
895 that [here are some details](https://github.com/solson/miri/issues/479).
896 Moreover, wouldn't it be nice if we could
897 [run the entire libcore, liballoc and libstd test suite in miri](https://github.com/rust-lang/rust/issues/54914)?
898 There are tons of interesting cases of Rust's core data structures being
899 exercise there, and the comparatively tiny miri test suite has already helped to
900 find two soundness bugs, so there are probably more.  Once `cargo miri test`
901 works again, it would be great to find a way to run it on the standard library
902 test suites, and set up something so that this happens automatically on a
903 regular basis (so that we notice regressions).
904
905 As you can see, there is more than enough work for everyone.  Don't be shy!  I
906 have a mere two weeks left on this internship, after which I will have to
907 significantly reduce my Rust activities in favor of finishing my PhD.  I won't
908 disappear entirely though, don't worry -- I will still be able to mentor you if
909 you want to help with any of the above tasks. :)
910
911 Thanks to @nikomatsakis for feedback on a draft of this post.  If you want to
912 help or report results of your experiments, if you have any questions or
913 comments, please join the
914 [discussion in the forums](https://internals.rust-lang.org/t/stacked-borrows-implemented/8847).