deploy: 8ed5d72bc9

index.xml

@@ -56,8 +56,9 @@ and at least one of them is <code>noalias</code>, there are some restricti
 <li>If one of them writes, they must not point to the same value (alias each other)</li>
 <li>If neither of them writes, they can alias just fine.
 Therefore, we also apply <code>noalias</code> to <code>&mut T</code> and <code>&T</code> (if it doesn’t contain interior mutability through
-<code>UnsafeCell<T></code>, since they uphold these rules.</li>
+<code>UnsafeCell<T></code>), since they uphold these rules.</li>
 </ul>
+<p>For more info on <code>noalias</code>, see <a href="https://llvm.org/docs/LangRef.html#parameter-attributes">LLVMs LangRef</a>.</p>
 <p>This might sound familiar to you if you’re a viewer of <a href="https://twitter.com/jonhoo">Jon Gjengset</a>’s content (which I can highly recommend). Jon has made an entire video about this before, since his crate <code>left-right</code>
 was affected by this (<a href="https://youtu.be/EY7Wi9fV5bk)">https://youtu.be/EY7Wi9fV5bk)</a>.</p>
 <p>If you’re looking for <em>any</em> hint that using box emits <code>noalias</code>, you have to look no further than the documentation
@@ -66,13 +67,13 @@ belong to the arcane circles of the select few who were aware of it. So lots of
 RAII pointer” (a pointer that allocates the value in the constructor, and deallocates it in the destructor on drop) for all
 pointers are concerned.</p>
 <h1 id="stacked-borrows-and-miri">Stacked Borrows and Miri</h1>
-<p>TODO: introduce UB by explaining how it allows optimizations like the one above, don’t talk in standardese</p>
-<p><a href="https://github.com/rust-lang/miri">Miri</a> is an interpreter for Rust code with the goal of finding undefined behaviour.
-Undefined behaviour, UB for short, is behaviour of a program upon which no restrictions are imposed. If UB is executed,
-<em>anything</em> can happen, including segmentation faults, silent memory corruption, leakage of private keys or exactly
-what you intended to happen. Examples of UB include use-after-free, out of bounds reads or data races.</p>
-<p>I cannot recommend Miri highly enough for all unsafe code you’re writing (sadly support for some IO functions
-and FFI is still lacking, and it’s still very slow).</p>
+<p>So, LLVM was completely correct in optimizing our code to make the assert fail. But what exactly gave it permission to do so?
+Undefined Behaviour (UB for short). Undefined behaviour is at the root of many modern compiler optimizations. But what is undefined behaviour?
+UB represents a contract between the program and the compiler. The compiler assumes that UB will not happen, and can therefore optimize based
+on these assumptions. Examples of UB also include use-after-free, out of bounds reads or data races. If UB is executed, <em>anything</em> can happen,
+including segmentation faults, silent memory corruption, leakage of private keys or exactly what you intended to happen.</p>
+<p><a href="https://github.com/rust-lang/miri">Miri</a> is an interpreter for Rust code with the goal of finding undefined behaviour in Rust. I cannot recommend Miri
+highly enough for all unsafe code you’re writing (sadly support for some IO functions and FFI is still lacking, and it’s still very slow).</p>
 <p>So, let’s see whether our code contains UB. It has to, since otherwise the optimizer wouldn’t be allowed to change
 observable behaviour (since the assert doesn’t fail in debug mode). <code>$ cargo miri run</code>…</p>
 <pre tabindex="0"><code class="language-rust,ignore" data-lang="rust,ignore">error: Undefined Behavior: attempting a read access using <3314> at alloc1722[0x0], but that tag does not exist in the borrow stack for this location
@@ -137,29 +138,36 @@ other box-exclusive features it offers. Even worse is <code>string_cache</
 <p>Then last but not least, there’s the opinionated fact that <code>Box<T></code> shall be implementable entirely in user code. While we are
 many missing language features away from this being the case, the <code>noalias</code> case is also magic descended upon box itself, with no
 user code ever having access to it.</p>
-<p>There are also several arguments in favour of box being unique and special cased here. To negate the last argument above, it can
+<p>There are several arguments in favour of box being unique and special cased here. To negate the last argument above, it can
 be said that <code>Box<T></code> <em>is</em> a very special type. It’s just like a <code>T</code>, but on the heap. Using this mental model, it’s very easy to
 justify all the box magic and its unique behaviour. But in my opinion, this is not a useful mental model regarding unsafe code,
 and I prefer the mental model of “reference that manages its own lifetime”, which doesn’t imply uniqueness.</p>
+<p>But there are also crates on <a href="https://crates.io/">crates.io</a> like <a href="https://crates.io/crates/aliasable">aliasable</a> that already
+provide an aliasable version of <code>Box<T></code>, which is used by the self-referential type helper crate <a href="https://crates.io/crates/ouroboros">ouroboros</a>.
+So if box stayed unique, people could also just pick up that crate as a dependency and use the aliasable box from there instead of
+having to write their own. Interestingly, this crate also provides a <code>Vec<T></code>, even though <code>Vec<T></code> can currently be aliased in practice and
+in the current version of stacked borrows. just fine, although it’s also not clear whether we want to keep it like this, but I
+don’t think this can reasonable be changed.</p>
 <h1 id="noalias-noslow">noalias, noslow</h1>
 <p>There is one clear potential benefit from this box behaviour: ✨Optimizations✨. <code>noalias</code> doesn’t exist for fun, it’s something
 that can bring clear performance wins (for <code>noalias</code> on <code>&mut T</code>, those were measureable). So the only question remains:
 <strong>How much performance does <code>noalias</code> on <code>Box<T></code> give us now, and how many potential performance improvements could we get in the
 future?</strong> For the latter, there is no simple answer. For the former, there is. <code>rustc</code> has <a href="https://github.com/rust-lang/rust/pull/99527"><em>no</em> performance improvements</a>
 from being compiled with <code>noalias</code> on <code>Box<T></code>.</p>
-<p>I have not yet benchmarked ecosystem crates without box noalias and don’t have the capacity to do so right now, so I would be very
-grateful if anyone wanted to pick that up and report the results.</p>
-<p>There are also crates on <a href="https://crates.io/">crates.io</a> like <a href="https://crates.io/crates/aliasable">aliasable</a> that already
-provide an aliasable version of <code>Box<T></code>, which is used by the self-referential type helper crate <a href="https://crates.io/crates/ouroboros">ouroboros</a>.</p>
+<p>I have also benchmarked a few crates from the ecosystem with and without noalias on box, and the <a href="https://gist.github.com/Nilstrieb/9a0751fb9fd1044a30ab55cef9a7d335">results</a>
+were inconclusive. (At the time of writing, only regex-syntax, tokio, and syn have been benchmarked.) regex-syntax showed no changes. Tokio showed a few improvements without noalias
+which is very weird, so maybe the benchmarks aren’t really good or something else was going on. And syn tended towards minor regressions without noalias, but the benchmarks had high
+jitter so no real conclusion can be reached from this either, at least in my eyes, but I don’t have a lot of experience with benchmarks. Therefore, I would love for more people
+to benchmark more crates, especially if you have more experience with benchmarks.</p>
 <h1 id="a-way-forward">a way forward</h1>
-<p>Based on all of this, I do have a few solutions. First of all, I think that even if there might be some small performance regressions in ecosystem crates,
-the overall tradeoff goes against the current box behaviour. Unsafe code wants to use box, and it is reasonable to do so. Therefore I propose to completely
-remove all uniqueness from <code>Box<T></code>, and treat it just like a <code>*const T</code> for the purposes of aliasing. This will make it more
-predictable for unsafe code, and comes at none or only a minor performance cost.</p>
-<p>But this performance cost may be real, and especially the future optimization value can’t be certain. The current uniqueness guarantees of box
+<p>Based on all of this, I do have a few solutions. First of all, I think that even if there might be some small performance regressions, they are not significant enough
+to justify boxes uniqueness. Unsafe code wants to use box, and it is reasonable to do so. Therefore I propose to completely remove all uniqueness from <code>Box<T></code>, and treat it
+just like a <code>*const T</code> for the purposes of aliasing. This will make it more predictable for unsafe code, and is a step forward towards less magic from <code>Box<T></code>.</p>
+<p>But the performance cost may be real, and especially the future optimization value can’t be certain. The current uniqueness guarantees of box
 are very strong, and still giving code an option to obtain these seems useful. One possibility would be for code to use a
 <code>&'static mut T</code> that is unleaked for drop, but the semantics of this are still <a href="https://github.com/rust-lang/unsafe-code-guidelines/issues/316">unclear</a>.
 If that is not possible, exposing <code>std::ptr::Unique</code> (with it getting boxes aliasing semantics) could be desirable. For this, all existing usages of <code>Unique</code>
-inside the standard library would have to be removed.</p>
+inside the standard library would have to be removed. We could also offer a <code>std::boxed::UniqueBox</code> that keeps the current semantics, but this would also bring direct aliasing
+decisions more towards safe code, which I am not a huge fan of. Ownership is enough already.</p>
 <p>I guess what I am wishing for are some good and flexible raw pointer types. But that’s still in the stars…</p>
 &lt;p>For more information about this topic, see &lt;a href="https://github.com/rust-lang/unsafe-code-guidelines/issues/326">https://github.com/rust-lang/unsafe-code-guidelines/issues/326&lt;/a>&lt;/p></content></item></channel></rss>