ralf/_drafts/formalizing-rust.md

   1 ---
   2 title: Formalizing Rust
   3 categories: research rust
   4 ---
   5
   6 My current research project - and the main topic of my PhD thesis - is about developing a *formal model* of the [Rust programming language](https://www.rust-lang.org/).
   7 Rust is an attempt of Mozilla to find a sweet spot in the design space of programming languages: A langauge that's safe to use, convenient for programmers, and guards against memory errors and thread unsafety.
   8 Other have [said](https://www.youtube.com/watch?v=O5vzLKg7y-k) and [written](http://www.oreilly.com/programming/free/files/why-rust.pdf) a lot on why we need such a langue, so I won't lose any more words on this.
   9 Let me just use this opportunity for a shameless plug: If you are curious and want to learn Rust, check out [Rust-101](https://www.ralfj.de/projects/rust-101/main.html), a hands-on Rust tutorial I wrote.
  10 I am going to assume some basic familiarity with Rust in the following.
  11
  12 Why do we want to formalize Rust? First of all, I'm (becoming) a programming languages researcher, and Rust is an interesting new langauge to study.
  13 It's going to be fun! Honestly, that's enough of a reason for me.
  14 But there's other reasons: It shouldn't be a surprise that [bugs](https://github.com/rust-lang/rust/issues/24292) have [been](https://github.com/rust-lang/rust/issues/26656) [found](https://github.com/rust-lang/rust/issues/24880) in Rust.
  15 There is lots of things that can be done about such bugs - my take on this is that we should try to *prove*, in a mathematical rigorous way, that no such bugs exist in Rust.
  16 This goes hand-in-hand with other approaches like testing, fuzzing and [static analysis](https://homes.cs.washington.edu/~emina/pubs/crust.ase15.pdf).
  17 However, we (at my [research group](http://plv.mpi-sws.org/)) are into formalizing things, so that's what we are going to do.
  18
  19 <!-- MORE -->
  20
  21 ## Scope
  22
  23 Let me just get this out of the way at the beginning: The first formal model is not going to cover all features of Rust.
  24 Some of the missing pieces will hopefully be added later, some maybe not.
  25 Rust is huge, it's too large to be all handled in a single go.
  26 In particular, the first version is not going to cover automatic destructors, i.e., the `Drop` trait and the dropck mechanism.
  27 This is, of course, a significant gap, even more so since dropck may well be the most subtle part of the type system, and the current version (as of Rust 1.3) is known to be unsound.
  28 But we have to start somewhere, and even without `Drop`, there's a lot to be done.
  29 We are also not going to have traits, unwinding and a few other pieces in the beginning.
  30 This is mostly to avoid getting distracted by all the details, and keep the focus on the most important bits.
  31 In terms of what we are interested in, none of these features significantly change the game.
  32 I have some good ideas for how to handle them later, should we have the time for that.
  33
  34 ## So what's left?
  35
  36 You may wonder now, what are we even doing then?
  37 We are focusing on the core typesystem: Ownership and borrowing.
  38 The goal is to prove that well-typed Rust programs are *memory and thread safe*, which, roughly speaking, means that all executed pointer accesses are valid, and there are no data races.
  39 I will often just say "memory safety", but concurrency is definitely part of the story.
  40
  41 ## The syntactic approach and its limitations
  42
  43 We could now be looking at the checks the Rust compiler is doing, and prove that these checks imply memory safety.
  44 This is of course an important property, and actually, this [has been done](ftp://ftp.cs.washington.edu/tr/2015/03/UW-CSE-15-03-02.pdf) already.
  45 However, this proof only gets us so far: The moment your program uses [`unsafe`](https://doc.rust-lang.org/stable/book/unsafe.html), this result does not apply to your program any more.
  46 It is the whole purpose of `unsafe` to permit writing dangerous code that the compiler cannot check, and hence any proof relying solely on such compiler checks simply does not apply.
  47 In some sense, programs containing `unsafe` are not well-typed.
  48 (More strictly speaking, they are well-typed in a more liberal type system that above result does not, and cannot, apply to.)
  49 Note that this issue is viral: `Vec`, `RefCell`, `Rc` - all these and many more standard library data structures use `unsafe`, any if your program uses any of them, you're out of luck.
  50
  51 ## Semantics to the rescue
  52
  53 Intuitively, why do we even think that a program that uses `Vec`, but contains no `unsafe` block *itself*, should be safe?
  54 It's not (just) the compiler checks making sure that we don't call `push` on a shared borrow.
  55 We also rely on `Vec` *behaving well* - or, I should rather say, *behaving well-typed*.
  56 Yes, `Vec` uses `unsafe` - but it should not be possible to *observe* this in a well-typed safe program, calling only the interface provided by `Vec`.
  57 There are some rules that Rust enforces, some invariants that safe, well-typed code automatically upholds, that people writing unsafe code have to maintain themselves.
  58 `Vec` performs checks and bookkeeping to get its tracking of the size and capacitity of the container right.
  59 `RefCell` counts the number of outstanding borrows, to make sure at run-time that no two mutable borrows to the same cell exist.
  60 `Rc` counts the number of references that are hold, and only if that reaches 0 it deallocates memory. Crucially though, it only hands out *immutable*, shared borrows to its conent.
  61 If any of these checks would be removed, the data structure would clearly be unsafe, and even safe code could witness that.
  62 But if the Rust authors got all these checks right, then safe code cannot even tell that unsafe operations are being performed.
  63
  64 <!-- MARK -->
  65
  66 This means there is something to *manually prove* about unsafe code: It has to behave as if it were well-typed.
  67 This is a notion that can actually be captured formally.
  68 Besides the merely syntactic notion of well-typedness that relies on a type checker matching the syntax of the program against a bunch of rules, one can define a *semantic* notion of well-typedess that is defined solely in terms of what one can *do* with a piece of code.
  69 For example, for a function to be syntactically well-typed, one goes ahead and looks at its code, and makes sure that code is written the right way.
  70 For a function to be *semantically* well-typed, however, one checks what the function does on every possible input, how the output looks like.
  71 The actual code doing this, does not matter.
  72 Only recently, research has been able to scale up such semantic methods to languages that combine state (i.e., mutable variables, a heap) with higher-order functions - languages like Rust, where I can take a closure (a `Fn{,Mut,Once}`) and store it in memory, for later use.
  73
  74 So, that's what we are trying to do: Come up not only with a formal version of Rust's (syntactic) type system, but also with appropriate *semantics* for these types.
  75 We then have to show that the syntactic types make semantic sense. This recovers, in a very roundabout way, the result I mentioned above:
  76 Every well-typed Rust program (that doesn't use `unsafe`, not even indirectly) is memory safe.
  77 However, now that we have these semantic types, we can go further and prove that `Vec`, `Rc`, `RefCell` are also *semantically well-typed*.
  78 By combining this manual proof with the first result covering all syntactically well-typed Rust programs, we finally obtain the desired proof that safe programs using only the unsafe bits that were proven correct, are memory safe.
  79
  80 Note that there are many semantic models we could give to the syntactc type system of Rust.
  81 But most of these will be too restricted, they will not actually allow `Rc` or `RefCell` (those two are particularily interesting) to be semantically well-typed - or some other data structure that is commonly believed to be safe to use.
  82 Hence coming up with the right semantic model involves understanding what it is that makes all these, and many more, data structures "right" - and fitting that into a formal definition that captures all the right properties.
  83 Once we got a proper semantic model, we also hope to be able to translate some of these insights back into the vocabulary of Rust programmers, and tell them what it is they have to be checking when writing unsafe Rust code.
  84 At this point, these exact rules are clear not even to the Rust team at Mozilla.
  85 At some point, hopefully, they are going to be laid out in [The Rustonomicon](https://doc.rust-lang.org/nightly/nomicon/) and guide future Rust programmers in their unsafe endavors.