RFC: No (opsem) Magic Boxes

[chorman0773]

Summary

Currently, the operational semantics of the type alloc::boxed::Box<T> is in dispute, but the compiler adds llvm noalias to it. To support it, the current operational semantics models have the type use a special form of the Unique (Stacked Borrows) or Active (Tree Borrows) tag, which has aliasing implications, validity implications, and also presents some unique complications in the model and in improvements to the type (e.g. Custom Allocators). We propose that, for the purposes of the runtime semantics of Rust, Box is treated as no more special than a user-defined smart pointer you can write today¹. In particular, it is given similar behaviour on a typed copy to a raw pointer.

Rendered

Footnotes

1. We maintain some trivial validity invariants (such as alignment and address space limits) that a user cannot define, but these invariants only depend upon the value of the Box itself, rather than on memory. ↩

[clarfonthey]

It feels odd that one of the clear options is left out: why not expose a Unique<T> that has the same semantics as Box<T>, so any smart pointer type can use it?

Like, I definitely agree that Box shouldn't have special semantics that you can't reproduce elsewhere. But among the options, it feels pretty limiting to come to the conclusion that we should eliminate those semantics, rather than just making them reproducible elsewhere.

I agree that whatever happens shouldn't be specific to the Global allocator, though.

[scottmcm]

We maintain some trivial validity invariants (such as alignment and address space limits) that a user cannot define

I, at least, fully expect us to eventually have some way of writing alignment-obeying raw pointers in Rust in some way. If nothing else, slice::Iter is less good than it could be because of the lack of them, and optimizing that type is super-important.

(Transmuting between NonNull<T> and unsafe<'a> &'a T is one thing that might work, for example, though it's also possible that the opsem for that will end up saying that it doesn't and that something else is required instead.)

EDIT: added a word to try to communicate that I wasn't expecting this RFC to include such a type.

[chorman0773]

I, at least, fully expect us to have some way of writing alignment-obeying raw pointers in Rust in some way. If nothing else, slice::Iter is less good than it could be because of the lack of them, and optimizing that type is super-important.

That's my hope for the future as well, but to avoid the RFC becoming too cluttered, I am refraining from defining such a type in this RFC.

[juntyr]

Is there a list of optimisations that depend on noalias being emitted for Box’es?

[clarfonthey]

The RFC seems pretty clear that noalias hasn't really provided many benefits compared to being an extra burden to uphold for implementers, but maybe it is worth seeing if there are any sources that can provide a bit more detail on that.

[kennytm]

sorry but is the term "typed copy" explained somewhere?

(the explanations I could find are from pretty unofficial places like a reddit¹ and urlo² post)

Footnotes

1. "they are like memcpy, but the copy occurs with a type, giving the compiler some extra power." ↩

2. "a typed copy consists of essentially decoding the AM-bytes into the abstract value then encoding that abstract value back to AM-bytes at the new location." ↩

[chorman0773]

The urlo definition is probably good.
It's defined in the opsem, but I don't know if we have a very good written record of that other than spread arround zulip threads and github issues.

[scottmcm]

I'm a fan of this. I think that people moving from Vec<T> to Box<[T]> having to deal with drastically-different soundness rules is a giant footgun, and getting rid of the special [ST]B behaviour here sounds good to me.

[nikomatsakis]

My general take:

The two "endpoints" here are

• Efficient end-user abstractions: this allows most safe code to run faster. This would have strong alias requirements and would not expose raw/unsafe details. This permits non-obvious optimizations (e.g., small string optimization or 0-length capacity).
• Building blocks for unsafe code: this exposes raw/unsafe details.

From what I can tell, we current orient Box as the former but Vec and String as the latter. That seems backwards, since if anything those are far more useful as abstractions than Box is.

If I could go back in time, I think I would favor end-user abstractions and offer different types (e.g., RawVec or RawBuffer or something) that exposed their innards, but I think that ship has sailed, and we might as well embrace the current situation (which is nice in some ways too).

[nikomatsakis]

The RFC would benefit from some attempt to quantify the impact on performance, though our lack of standardized runtime benchmarks makes that hard.

[traviscross]

@rust-lang/opsem: We were curious in our discussions, does this RFC represent an existing T-opsem consensus?

[chorman0773]

We were curious in our discussions, does this RFC represent an existing T-opsem consensus?

It does not represent any FCP done by T-opsem, which is why I've included them here. The claims I make, including those about the impact on the operation semantics, are included in the request for comment and consensus.

The RFC would benefit from some attempt to quantify the impact on performance, though our lack of standardized runtime benchmarks makes that hard.

I recall some perf PR's (using the default rustc-perf suite) being done to determine the impact, which showed negligible impact. I can probably pull them up at some point in the RFC's lifecycle.

• [perf experiment] Don't emit noalias for box when compiling rustc itself rust#99527 is such PR, and showed only a secondary regression of 1.9% in Cycle Count, but an improvement in Max RSS of 4.0% on average.

[RalfJung]

The Reference has been adjusted a while ago to state validity invariants positively, i..e by listing what must be true, instead of listing what must not be false. IMO that's more understandable, and the RFC should be updated to also do that.

[RalfJung]

I agree that whatever happens shouldn't be specific to the Global allocator, though.

There are patterns of using a custom per-Box allocator that are incompatible with the aliasing requirements, at least under our current aliasing models. See rust-lang/miri#3341 for an example. So if we always make Box be unique, we have to declare those allocators to be UB.

Is there a list of optimisations that depend on noalias being emitted for Box’es?

It's "every LLVM optimization that looks at alias information". The question is how much that matters in practice, which is hard to evaluate.

We were curious in our discussions, does this RFC represent an existing T-opsem consensus?

As Connor said, not in any formal sense. Several opsem members have expressed repeatedly that they want to see noalias on Box go, but I don't know whether we have team consensus on this.

My own position is that I love how this simplifies the model and Miri, I am just slightly concerned about this being an irreversible loss of optimization potential that we might regret later. Absence of evidence of optimization benefit is not evidence of absence. Our benchmarks likely just don't have a lot of functions that take Box<T> by value. However, that in itself is an indication that the optimization benefit is likely limited.

Is there a way we can query the ecosystem for functions taking Box<T> by value?

[RalfJung]

This is actually the status quo, since rust-lang/rust#122018

[clarfonthey]

Just to follow up on some of the discussion, it wasn't immediately clear to me that types similar to Box, like Vec and Arc, genuinely don't have these semantics, even though it is implied by the fact that Box is unique in this regard. I think this is worth emphasising more in the text of the RFC, since in a very real sense, we've been going without these semantics for most^{[citation needed]} parts of Rust totally fine, which further emphasises less will be lost by removing it for Box.

I would still love if there's more data showing the lack of returns on noalias optimisations, since it feels wrong that something with a lot of history and usage isn't helping that much, but the fact that Vec and other types don't have this optimisation at least helps us understand that it's not going to cause any performance issues if removed.

[chorman0773]

I am just slightly concerned about this being an irreversible loss of optimization potential that we might regret later

FTR, speaking right now as one of the main developers of lccc, my opinion is that the best way to mitigate any loss of future optimization potential is to just be far more granular with &mut. I don't think spamming extra noalias on parameters is necessary if we just emit more metadata on derefs (llvm's scoped noalias and dereferenceable, and lccc's unique and dereferenceable type attributes). If there are problems with doing that, I don't think this is a place where we should necessarily bend the whole language to this one attribute on one backend, especially given the complexity of maintaining the feature as-is, where we keep running into fundamental issues with the special treatment of Box. If there are legitimate optimizations lost as a result of the function level noalias, that can't be made up with more granular scoping on dereferences, that may be a different consideration, but my view is that the language after this change has the semantics necessary to justify at the very least a majority of the optimizations that may ultimately be lost, and its up to rustc and llvm (and other compilers) to make use of those semantics if they wish to.

Just to follow up on some of the discussion, it wasn't immediately clear to me that types similar to Box, like Vec and Arc, genuinely don't have these semantics, even though it is implied by the fact that Box is unique in this regard. I think this is worth emphasising more in the text of the RFC, since in a very real sense, we've been going without these semantics for most parts of Rust totally fine, which further emphasises less will be lost by removing it for Box.

I mentioned Vec<T> in particular, and also mentioned std::unique_ptr<T> from C++, which is the most closely equivalent type, and lacks the same semantic implications (and also optimizations).

[scottmcm]

Just to follow up on some of the discussion, it wasn't immediately clear to me that types similar to Box, like Vec and Arc, genuinely don't have these semantics

And more than them just not having them, IIRC someone tried to implement Vec<T> as the obvious wrapper around Box<[MaybeUninit<T>]>, and in the process found out that lots of people are depending on Vec not having them.

[RalfJung]

would still love if there's more data showing the lack of returns on noalias optimisations, since it feels wrong that something with a lot of history and usage isn't helping that much

It helps for references. I suspect people added it for Box because "why not".

[RalfJung]

This looks to be a new guarantee? We currently don't normatively say anything about the layout of Box, AFAIK.

Also see this; Cc @CAD97

[chorman0773]

Stdlib docs promise it has the same layout and abi as a pointer, and also promises niche optimization.

https://doc.rust-lang.org/alloc/boxed/index.html#memory-layout

So long as T: Sized, a Box<T> is guaranteed to be represented as a single pointer and is also ABI-compatible with C pointers (i.e. the C type T*).

https://doc.rust-lang.org/core/primitive.fn.html#abi-compatibility

*const T, *mut T, &T, &mut T, Box<T> (specifically, only Box<T, Global>), and NonNull<T> are all ABI-compatible with each other for all T. They are also ABI-compatible with each other for different T if they have the same metadata type (<T as Pointee>::Metadata).

(The last sentence implies the abi, and thus layout, holds for T: !Sized pointers as well)

[RalfJung]

Ah okay :)

[ZuseZ4]

Just catching up with things. I wanted to share that for automatic differentiation (and likely GPU Kernels written in pure Rust) noalias is very relevant. At the llvm-dev meeting I've been presenting 5 benchmark that showed Performance Penalties in 4/5 Benchmarks ranging from 30% - 10x by removing noalias from the Rust code. Removing noalias from the C++ version of the benchmark also had large performance impacts (up to 4x), so it's not a pure Rust problem, and noalias is just generally very valuable for AutoDiff and GPU support. The only benchmark not suffering didn't had enough pointers/references for noalias to be valuable.

For now I have to admit that I have written all benchmarks using slices or arrays and not box, but both autodiff and GPU offload work on llvm-ir, and there are logical reasons about why noalias has such a big performance impact. So I don't see any reason why the penalty for noalias should be smaller for box. I will try to get at least some of these Benchmarks ported to use a Box instead of slices to prove my point, but for now I can share the existing slice/array versions that I used for my talk: EnzymeAD/Enzyme#1797

That being said, both autodiff and gpu-offloading are of course only experimental project goals, and noalias on box is of course less relevant than noalias on say slices. However, I think especially efficient GPU support is valuable beyond the scientific Computing/HPC/ML crowd and of interest for a lot of people. It might still be worth dropping it if it causes too many compiler issues, I haven't read up on the whole discussion yet. But we should at least be aware then that it likely will have relevant performance impact for these targets. If desired, I can also reach out to some of the LLVM people involved in GPU programming, they surely can provide more numbers/examples on noalias usage there.

Edit: Iirc Nikita also pointed out that people often pass Box behind a reference, which would keep noalias, so that might be enough for our cases (I will need to check the IR).

[GoldsteinE]

So I don't see any reason why the penalty for noalias should be smaller for box.

The idea is that box doesn’t get passed around that much: you usually just pass a reference, and mutable references have noalias.

(This is distinct from passing a box behind a reference / a reference to a box, which would have noalias on the reference, but not on the box)

[ZuseZ4]

Agree, but in our case the existence of 2+ Box types inside of a function (with at least one write to it) would often force us to cache the data behind all Boxes for autodiff (instead of just the one we modified), so it's not only about passing it to other functions. Vectors also don't have noalias iirc so I think also any combination of 2+ vec/box types existing in one function could then cause unnecessary copies.

I want to be clear that the average IR from Rust is still miles ahead of the average IR we get from C++ (since people rarely use restrict), but the difference would be that people manually could fix C++ by adding restrict, whereas Rust users wouldn't be able to add noalias to Rust's builtin types. It might still be worth to sacrifice performance in some niche cases for easier correctness, I'll try to write up in more detail under which cases lacking noalias would have an impact for the HPC/etc. community so people can decide if it's worth it. I just wanted to share this as an FYI, while I'm working out more details on it.

[chorman0773]

Within a function you already don't get noalias, due to limitations of llvm and what code rustc emits.

[ZuseZ4]

Are you talking about sret preventing noalias? Yes, we're following the work on the llvm side too, e.g. https://discourse.llvm.org/t/restrict-noalias-for-struct-members/78568, so we hope to increase the number of locations where llvm can use noalias info. I however don't have precise insights on how many of these llvm noalias improvements will later be useable by Rust and where we e.g. already allow unsafe code to alias and thus won't be able to add noalias.

[RalfJung]

Are you talking about sret preventing noalias?

No, he's talking about the fact that syntactically in LLVM IR noalias only exists for function arguments, not inside a function.

Agree, but in our case the existence of 2+ Box types inside of a function (with at least one write to it) would often force us to cache the data behind all Boxes for autodiff (instead of just the one we modified), so it's not only about passing it to other functions.

This can't be happening today since, as Connor said, noalias in LLVM is only for arguments. So are you speculating here about what benefits there might be in a hypothetical future where Box has noalias and also LLVM has a way to represent this inside a function, and Rust uses it?

Would be good to know which parts of your comments are based on concrete data and which are speculative.

[RalfJung]

and noalias is just generally very valuable for AutoDiff and GPU support

That's a good point that I had not considered. Would be good to get some data on the GPU side here, too.

[scottmcm]

I want to be clear that the average IR from Rust is still miles ahead of the average IR we get from C++ (since people rarely use restrict), but the difference would be that people manually could fix C++ by adding restrict, whereas Rust users wouldn't be able to add noalias to Rust's builtin types.

They could delegate to an inner function taking &mut to get noalias though, no?

(Like how autovectorization works better on &mut [T]/&[T] parameters than on Vec<T>, so you do the same thing there.)

[comex]

This can't be happening today since, as Connor said, noalias in LLVM is only for arguments. So are you speculating here about what benefits there might be in a hypothetical future where Box has noalias and also LLVM has a way to represent this inside a function, and Rust uses it?

Just to clarify, LLVM does have something called noalias that is not for arguments, namely noalias metadata. rustc will not directly produce this metadata, but it arguably could and should. Also note that this metadata can already end up in Rust code because LLVM converts function-argument-noalias to scoped-noalias upon inlining. (This does not alter the semantics.)

[RalfJung]

Yeah noalias metadata exists but it's largely a separate system from noalias arguments, as far as I can tell. If the semantics of noalias arguments are poorly understood, then the semantics of noalias metadata are a complete mystery -- I don't know anyone who has even the faintest clue of what the actual rules for the metadata are (in an operational sense).

[scottmcm]

I think we should just do this, and make Box like Vec and Rc and friends in this way.

I agree with Niko's post above that ideally we'd have made Box and Vec the super-strict ones from 1.0 -- I imagine things like Vec::pop writing uninitialized over the memory, so you can't use it later even in unsafe -- but that ship has long since sailed.

Thus I think it's better that we not have a big footgun of code that's sound with Vec<T> being unsound with Box<[T]>, even if that will potentially cost us some optimizations. After all, one already should write functions over &[T] and &mut [T] instead of &Vec<T> and &mut Vec<T>, so this would just make that true for Box as well -- if you really need the noalias rules, delegate to something taking references.

@rfcbot fcp merge

[rfcbot]

Team member @scottmcm has proposed to merge this. The next step is review by the rest of the tagged team members:

• @CAD97
• @JakobDegen
• @RalfJung
• @digama0
• @joshtriplett
• @nikomatsakis
• @pnkfelix
• @saethlin
• @scottmcm
• @tmandry
• @traviscross

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

cc @rust-lang/lang-advisors: FCP proposed for lang, please feel free to register concerns.
See this document for info about what commands tagged team members can give me.

[traviscross]

@rustbot labels +I-lang-nominated

Thus I think it's better that we not have a big footgun of code that's sound with Vec<T> being unsound with Box<[T]>

Is this footgun actually big, though? It gave me a lot of pause about doing this when @RalfJung said:

I am not aware of a single real-world usage of Vec that actually breaks the noalias rules.

If that's true, maybe we should consider whether we can in fact go the other way somehow.

As a rule, I would like to make things less magical. But here -- I don't know -- I wonder whether it's an improvement to lose this optimization and to, in some situations, have to suggest that people write inner functions like this:

// Without the inner function, this would take a long long time with
// `-Zbox-noalias=no`.
pub fn f_box(mut x: Box<[u64; 1]>, y: Box<[u64; 1]>) -> u64 {
    fn inner(x: &mut [u64; 1], y: &[u64; 1]) -> u64 {
        let mut z: u64 = 0;
        for i in 0..const { 2u64.pow(40) } {
            x[0] = i;
            z = z.wrapping_add(y[0]);
        }
        z
    }
    inner(&mut *x, &*y)
}

That's its own kind of new footgun that we'd be adding.

It's particularly kind of odd here since there's still of course the library invariant that a Box exposed to safe Rust must not alias other live things. Obviously that constrains potential use cases rather dramatically. And -- it's maybe a minor point, but -- from a pedagogical perspective, it seems unfortunate to increase the gap between the language and library invariants.

The stated motivation for this RFC leans a lot on the ManuallyDrop<Box<T>> case, but we fixed that in a different way in RFC 3336 (MaybeDanging).

So I just wonder whether there's a strong enough reason to do this, given (quoting @RalfJung again):

I am just slightly concerned about this being an irreversible loss of optimization potential that we might regret later. Absence of evidence of optimization benefit is not evidence of absence.

[saethlin]

I am not aware of a single real-world usage of Vec that actually breaks the noalias rules.

What is this based on? I'm not aware of any checker that we have for the noalias rules that would enable a systematic search.

[RalfJung]

It is based on the fact that, to my knowledge, so far we have not discussed even an artificial example of code that violates noalias in Vec.

It is often claimed that examples like this are UB under noalias:

let mut v = Vec::with_capacity(10);
v.push(0);
let ptr0 = &raw mut v[0];
let mut v = v; // move the Vec
v.push(1);
let ptr1 = &raw mut v[1];
ptr::swap(ptr0, ptr1);

That's just not true. Stacked Borrows and Tree Borrows rule out patterns like this, but noalias is less restrictive than that. Specifically, noalias on an argument is only relevant inside the function; once the function has returned, there are no more aliasing restrictions on pointers derived from such an argument. In contrast, Stacked Borrows and Tree Borrows remember "where the returned reference comes from" and keep enforcing non-aliasing.

We don't have any way to do systematic testing. But not even having a single realistic example of such UB does make me wonder how much of a problem it would be. IMO we should be asking: what is the support for the claim that adding noalias to Vec's buffer pointer would cause any UB in code we care about?

[RalfJung]

So, here is such an example:

unsafe fn f(mut v: Vec<i32>, ptr: *mut i32) {
    *ptr = 0;
    v[0] = 0;
}

let mut v = vec![0];
let ptr = &raw mut v[0];
f(v, ptr);

This is UB because inside f, we are accessing v[0] via both v and ptr. We could access other elements in f just fine, and even push_within_capacity to the vector. Only accessing the same element is an issue.

OTOH, also note that we could currently not even compile this to a noalias on the LLVM side since v is passed indirectly. We'd need to do some work on our ABI so that the three Vec fields are passed as three separate arguments.

[GoldsteinE]

There’s always an option of having a Box<_> be noalias but not dereferenceable_on_entry. That both doesn’t lose the optimizations in the @traviscross’s example and fixes the ManuallyDrop<_> issue. I am guessing (but I don’t have a proof) that actually dereferencing the Box<_> inside of a function body would lead LLVM to infer dereferencability anyway. (In any case, dereferenceable_on_entry doesn’t even exist, so we’re only losing potential optimizations if it’s ever added)

[RalfJung]

There’s always an option of having a Box<_> be noalias but not dereferenceable_on_entry.

That would have to be a weaker noalias than SB/TB, since their noalias requires dereferenceable_on_entry. SB doesn't support such a weaker noalias at all, would TB support it by treating Box<T> almost like a ZST reference.

[chorman0773]

I am not aware of a single real-world usage of Vec that actually breaks the noalias rules.

FTR, I don't like this argument - whether or not its true, it has no bearing on what is undefined behaviour in Rust. None of the proposed aliasing models for Rust that I've seen are "Exactly noalias, no more, no less". Whenever rustc emits llvm noalias, that must be justified by undefined behaviour at the rust level.

Part of the point of this RFC is removing special cases in the memory model, so IMO it's completely against the proposal to add even more special-cased rules to SB or TB to handle something closer to what noalias does specifically for Box<T> and Vec<T>.

[RalfJung]

Rust doesn't yet have an aliasing model, only several WIP proposals. If there's some good benefit from having noalias on Vec arguments, it would be reasonable to say that the proposals should be extended to be able to support that.

[traviscross]

Are there any differences semantically between what is proposed for Box<_> in this RFC and what would be true of MaybeDangling<Box<_>> today?

That is, since we already accepted RFC 3336, if there is no daylight between these, then it should say that normatively, and it perhaps could even lean into that for defining the semantics.

cc @RalfJung

[RalfJung]

We haven't spelled out whether MaybeDangling<Box<_>> would allow pointers too close to the end of the address space, but it seems reasonable to say "no" to that. In that case the answer to your question is yes, this RFC proposes to weaken Box so that its validity requirements are equivalent to MaybeDangling<Box<_>>.

[chorman0773]

Are there any differences semantically between what is proposed for Box<_> in this RFC and what would be true of MaybeDangling<Box<_>> today?

Restating Ralf's answer to this, MaybeDangling only removes aliasing invariants, but preserves the normal validity invariants of the type. This RFC proposes to remove the aliasing invariants from Box<_> as a whole, so it would naturally leave it in an identical state to MaybeDangling<Box<_>>.

However, this also spells out that validity invariant in full, which we cannot rely on existing types yet to do.

[traviscross]

The problems described in these motivation items are also solved by MaybeDangling, no?

Either way, the motivation should be adjusted to describe this. That is, it's confusing for the motivation to be written as though we did not already cover this ground and accept RFC 3336. If that RFC did solve the problem, but the idea is that the present proposal solves it better for Box<_> somehow, then that should be described here. Or alternatively, if there's some way in which RFC 3336 did not solve the problem, then that should be detailed specifically.

[chorman0773]

Only the last one. unless we say that in order to use a custom allocator with Box, you have always have to wrap the box in MaybeDangling (in which case, I'm not sure how to create one in the first instance).

[RalfJung]

This doesn't properly explain why "(almost) any non-trivial allocator" violates noalias.

There is a class of non-trivial custom allocators that violates Stacked Borrows, specifically if it accesses "metadata memory" that is stored outside the region returned by the allocator, using the pointer that was passed in to deallocate. If that's what you mean, it should be stated explicitly. Is that really "almost any non-trivial allocator"? That seems like a strong claim. It took a while for Miri to run into this issue.

With Tree Borrows, at least some of these cases are not UB any more, since Tree Borrows supports the &Header pattern.

[bjorn3]

It took a while for Miri to run into this issue.

Most people likely don't use custom allocators with miri.