Skip to content

explicitly keep the door open for some but not all subobject provenance - #2338

Open
RalfJung wants to merge 1 commit into
rust-lang:masterfrom
RalfJung:subobject-provenance
Open

explicitly keep the door open for some but not all subobject provenance#2338
RalfJung wants to merge 1 commit into
rust-lang:masterfrom
RalfJung:subobject-provenance

Conversation

@RalfJung

@RalfJung RalfJung commented Aug 23, 2026

Copy link
Copy Markdown
Member

Miri has enforced fairly strict subobject provenance by default since ~forever, but the Reference never explicitly called this out as UB. Let's fix that. This is the conservative choice; we document this as UB now and maybe lift the UB restriction again in the future.

This PR includes two commitments that @rust-lang/opsem (and maybe @rust-lang/lang) should FCP:

  • While we generally keep the door open for subobject provenance, we explicitly say that there is no subobject provenance within arrays/slices. This is based on the observation that violations of such subobject provenance are the major kind of Stacked Borrows UB that Miri finds. I'd like to make Miri stop report this as UB, and for this I'd like to be sure that indeed we don't want to make this UB.
  • While we generally keep the door open for "discriminant protection", we do explicitly say that it is okay to temporarily change the discriminant of an enum via a field reference, and then change it back. This is needed to make code like this sound, which came up multiple times in questions recently (1, 2).

I proposed for opsem to FCP these two choices in:

This PR should only be merged once both of those FCP completed.

@rustbot rustbot added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label Aug 23, 2026
@RalfJung
RalfJung force-pushed the subobject-provenance branch from d265a11 to fe2f637 Compare August 23, 2026 21:57
@RalfJung RalfJung changed the title explicitly keep the door open for some subobject provenance explicitly keep the door open for some but not all subobject provenance Aug 23, 2026
@traviscross traviscross added the I-lang-docs-nominated Nominated for discussion during a lang-docs team meeting. label Aug 24, 2026
@RalfJung
RalfJung force-pushed the subobject-provenance branch from fe2f637 to 019ee5a Compare August 24, 2026 09:18
@traviscross traviscross added I-lang-radar Items that are on lang's radar and will need eventual work or consideration. T-lang Relevant to the language team. T-opsem Team: opsem needs-fcp labels Aug 25, 2026

Generally, a reference may only access the memory it [points to].
This restriction also applies to all raw pointers derived from this reference.
The one exception is that a reference to an element of an array or slice may be used to access other elements of the same array or slice without immediately causing undefined behavior.

@joshlf joshlf Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this play with transmutes? Consider:

#[repr(C)]
struct Pair {
    first: [usize; 4],
    second: [usize; 4],
}

let pair = &Pair { ... };
let arr: &[usize; 8] = unsafe { &*(pair as *const Pair) };
let i0: *const usize = &arr[0];
let i7 = unsafe { i0.add(7) };
let i7 = unsafe { &*i7 };

This goes from:

  • &Pair to &[usize; 8] (a sound transmute)
  • ...to a raw pointer to the 0th element
  • ...to a raw pointer to the 7th element
  • ...to a reference to the 7th element

Presumably if we skipped the &Pair -> &[usize; 8] step and instead constructed i0 from &pair.first[0], this would be unsound because it would entail jumping between first and second.

Two questions:

  • Am I correct that the code as written is sound, and that if we skipped &Pair -> &[usize; 8], it would not be sound?
  • If so, what accounts for the differing soundness between these two examples?

View changes since the review

Generally, a reference may only access the memory it [points to].
This restriction also applies to all raw pointers derived from this reference.
The one exception is that a reference to an element of an array or slice may be used to access other elements of the same array or slice without immediately causing undefined behavior.
This exception also applies for nested arrays, but not for fields of values inside arrays.

@joshlf joshlf Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we clarify what "this exception also applies for nested arrays" means? I presume it means that you can go from e.g. x[0][0] to x[1][1] (where x: [[usize; 2]; 2])? What about from x[0] to x[1][1] or from x[0][0] to x[1]?

View changes since the review

This exception also applies for nested arrays, but not for fields of values inside arrays.

Furthermore, a reference to a field of an enum may not be used to change the discriminant of said enum.
If the tag lies inside the range of memory accessible by the reference (as in the previous paragraph), then the reference may be used to *temporarily* change the discriminant of the enum without immediately causing undefined behavior, but the original discriminant must be restored before the lifetime of the reference ends.

@joshlf joshlf Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "as in the previous paragraph" refer to?

View changes since the review

This exception also applies for nested arrays, but not for fields of values inside arrays.

Furthermore, a reference to a field of an enum may not be used to change the discriminant of said enum.
If the tag lies inside the range of memory accessible by the reference (as in the previous paragraph), then the reference may be used to *temporarily* change the discriminant of the enum without immediately causing undefined behavior, but the original discriminant must be restored before the lifetime of the reference ends.

@joshlf joshlf Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if changing the discriminant has the effect of just doing a transmute? E.g.:

#[repr(u8)]
enum Zero { Zero = 0 }

#[repr(u8)]
enum One { One = 1 }

enum Bit {
    Zero(Zero),
    One(One),
}

If Rust chooses to niche-optimize Bit so that there's no explicit discriminant, then given *mut Zero pointing to the only field of Bit::Zero, you could overwrite it with One::One and you'd effectively have transmuted the entire Bit to Bit::One(One::One). Is this sound even if the discriminant is not restored?

View changes since the review

This exception also applies for nested arrays, but not for fields of values inside arrays.

Furthermore, a reference to a field of an enum may not be used to change the discriminant of said enum.
If the tag lies inside the range of memory accessible by the reference (as in the previous paragraph), then the reference may be used to *temporarily* change the discriminant of the enum without immediately causing undefined behavior, but the original discriminant must be restored before the lifetime of the reference ends.

@joshlf joshlf Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We often say that lifetimes are not relevant to opsem. What does the term "lifetime" mean in this context? Is this about crossing an API boundary (i.e., this is really a safety thing about what you're allowed to assume when an enum reference/pointer crosses an API boundary), or is this about SB/TB, or something else?

View changes since the review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

I-lang-docs-nominated Nominated for discussion during a lang-docs team meeting. I-lang-radar Items that are on lang's radar and will need eventual work or consideration. needs-fcp S-waiting-on-review Status: The marked PR is awaiting review from a maintainer T-lang Relevant to the language team. T-opsem Team: opsem

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants