cargo-careful needs nightly
[web.git] / ralf / _posts / 2017-06-06-MIR-semantics.md
index e09212038250c44a29f7f8e3f7b014b4b0d2868e..c7fbbc93aa282aa85595b263ea89389f53d1170f 100644 (file)
@@ -1,12 +1,13 @@
 ---
 title: Exploring MIR Semantics through miri
 categories: internship rust
+reddit: /rust/comments/6fqzub/exploring_mir_semantics_through_miri/
 ---
 
 It's now been two weeks since my internship started (two weeks already, can you believe it?).
 In other words, if I want to post "weekly or bi-weekly" updates, I better write one today ;) .
 
-As [already mentioned]({{ site.baseurl }}{% post_url
+As [already mentioned]({% post_url
 2017-05-23-internship-starting %}), the goal for this internship is to
 experiment with
 [unsafe code guidelines](https://internals.rust-lang.org/t/next-steps-for-unsafe-code-guidelines/3864)
@@ -19,8 +20,8 @@ This post is about what I found, and it also serves as a nice demonstration of h
 
 ## Live and Let Die
 
-The first miri task that I took on was for miri to do something sensible with MIR's [`StroageLive` and `StroageDead` statements](https://github.com/solson/miri/issues/49).
-If you haven't seen these before, that's because they do not come up in Rust code; instead, `StroageLive` and `StroageDead` are inserted by the compiler.
+The first miri task that I took on was for miri to do something sensible with MIR's [`StorageLive` and `StorageDead` statements](https://github.com/solson/miri/issues/49).
+If you haven't seen these before, that's because they do not come up in Rust code; instead, `StorageLive` and `StorageDead` are inserted by the compiler.
 For example, the following Rust code
 {% highlight rust %}
 fn main() {
@@ -61,7 +62,7 @@ For example, the compiler marks `_4` as dead right after the multiplication.
 
 Liveness information is important because it is forwarded to LLVM, which then uses this information to allocate variables into stack slots.
 If two variables are never live at the same time, the compiler can assign both of them the *same* slot, which is great because it makes the stack frame smaller.
-To this end, rustc will translate `StorageLive` to [`llvm.lifetime.start`](http://llvm.org/docs/LangRef.html#llvm-lifetime-start-intrinsic) and `StroageDead` to [`llvm.lifetime.end`](http://llvm.org/docs/LangRef.html#llvm-lifetime-end-intrinsic).
+To this end, rustc will translate `StorageLive` to [`llvm.lifetime.start`](http://llvm.org/docs/LangRef.html#llvm-lifetime-start-intrinsic) and `StorageDead` to [`llvm.lifetime.end`](http://llvm.org/docs/LangRef.html#llvm-lifetime-end-intrinsic).
 These are intrinsics that LLVM understands and takes into account when computing the layout of the stack frame.
 
 ## Giving It Semantics
@@ -139,7 +140,7 @@ So, did we find a bug?
 
 Well, maybe.
 Or maybe the rules we picked were just too conservative.
-At this point, I ended up in a lengthy discussion with @eddyb and @arielb1, who both know approximately infinitely more about LLVM and rustc than I do, and this is how the third option in the list arose:
+At this point, I ended up in a lengthy discussion with @eddyb and @arielb1 and some folks in #rustc, who know approximately infinitely more about LLVM and rustc than I do, and this is how the third option in the list arose:
 When performing `StorageLive` on a variable that already is live, forget the value that is currently in the local variable, but otherwise keep it live.
 This is consistent with what we have caught LLVM doing.
 It is hard to get any more definite than this.
@@ -150,7 +151,7 @@ This is not very satisfying, but lacking a more precise description of the LLVM
 The good news is that with this choice of MIR semantics, miri's test suite passes.
 We can thus be sure (well, insofar as the test suite is representative -- this will hopefully get better over time) that rustc produces code that follows our new rules.
 
-## And the moral of this story
+## And the Moral of This Story
 
 So, what did we learn?
 
@@ -175,3 +176,5 @@ There will be a tension between the semantics being "conservative enough" such t
 There will be back and forth between various alternatives, and in the end, hopefully there will be a compromise that everybody can accept.
 
 Happy safe hacking!
+
+#### Footnotes