rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

compiler: Document the offset invariant of OperandValue::Pair

Browse Source
This commit is contained in:
Jubilee Young
2025-06-04 14:25:38 -07:00
parent df8102fe5f
commit 64df9e3c8a
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
compiler/rustc_codegen_ssa/src/mir/operand.rs
View File

@@ -45,9 +45,15 @@ pub enum OperandValue<V> {
Immediate(V), Immediate(V),
/// A pair of immediate LLVM values. Used by wide pointers too. /// A pair of immediate LLVM values. Used by wide pointers too.
/// ///
/// An `OperandValue` *must* be this variant for any type for which /// # Invariants
/// - For `Pair(a, b)`, `a` is always at offset 0, but may have `FieldIdx(1..)`
/// - `b` is not at offset 0, because `V` is not a 1ZST type.
/// - `a` and `b` will have a different FieldIdx, but otherwise `b`'s may be lower
/// or they may not be adjacent, due to arbitrary numbers of 1ZST fields that
/// will not affect the shape of the data which determines if `Pair` will be used.
/// - An `OperandValue` *must* be this variant for any type for which
/// [`LayoutTypeCodegenMethods::is_backend_scalar_pair`] returns `true`. /// [`LayoutTypeCodegenMethods::is_backend_scalar_pair`] returns `true`.
/// The backend values in this variant must be the *immediate* backend types, /// - The backend values in this variant must be the *immediate* backend types,
/// as returned by [`LayoutTypeCodegenMethods::scalar_pair_element_backend_type`] /// as returned by [`LayoutTypeCodegenMethods::scalar_pair_element_backend_type`]
/// with `immediate: true`. /// with `immediate: true`.
Pair(V, V), Pair(V, V),