rustc_public/

abi.rs

use std::fmt::{self, Debug};
use std::num::NonZero;
use std::ops::RangeInclusive;

use serde::Serialize;

use crate::compiler_interface::with;
use crate::mir::FieldIdx;
use crate::target::{MachineInfo, MachineSize as Size};
use crate::ty::{Align, Ty, VariantIdx, index_impl};
use crate::{Error, ThreadLocalIndex, error};

/// A function ABI definition.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct FnAbi {
    /// The types of each argument.
    pub args: Vec<ArgAbi>,

    /// The expected return type.
    pub ret: ArgAbi,

    /// The count of declared arguments (excluding variadic and implicit arguments).
    ///
    /// This may be less than `args.len()` for C variadic functions (which have
    /// additional variadic arguments) or `#[track_caller]` functions (which have
    /// an implicit caller location argument).
    pub fixed_count: u32,

    /// The ABI convention.
    pub conv: CallConvention,

    /// Whether this is a variadic C function,
    pub c_variadic: bool,
}

/// Information about the ABI of a function's argument, or return value.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct ArgAbi {
    pub ty: Ty,
    pub layout: Layout,
    pub mode: PassMode,
}

/// Different modes in which indirect arguments can be passed.
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Serialize)]
pub enum IndirectMode {
    /// Passed as a normal pointer, nothing special.
    Pointer,
    /// The value is placed at a fixed stack offset rather than passed as a regular pointer
    /// argument.
    OnStack,
    /// Similar to `OnStack` except that the pointer does not necessarily point to the stack, no
    /// extra copy is made, and the passed argument should not be modified.
    AmdgpuKernelArg,
}

/// How a function argument should be passed in to the target function.
///
/// The pass mode is determined by the platform's calling convention and the
/// argument's type layout. The same Rust type may use different pass modes
/// on different targets or when register availability changes.
///
/// Note: for the Rust ABI, pass modes may not correspond to any valid C
/// calling convention (e.g., using more return registers than the platform
/// C ABI allows). Further processing may be needed depending on the target.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum PassMode {
    /// Ignore the argument.
    ///
    /// The argument is either uninhabited or a ZST (zero-sized type).
    Ignore,
    /// Pass the argument directly in a single register.
    ///
    /// Used for primitive types and small values that fit in one register.
    Direct(ArgAttributes),
    /// Pass the argument directly in two registers.
    ///
    /// Used for types represented as a pair of values (e.g., a fat pointer
    /// consisting of a data pointer and a length/vtable pointer).
    Pair(ArgAttributes, ArgAttributes),
    /// Pass the argument after reinterpreting it as a different register layout.
    ///
    /// Used for aggregates (structs, tuples) that the platform ABI passes in
    /// registers. The argument's bytes are reinterpreted as the register
    /// sequence described by [`CastTarget`]. See its documentation for details.
    Cast { pad_i32_count: u8, cast: CastTarget },
    /// Pass the argument indirectly via a pointer.
    ///
    /// The caller places the value in memory and depending on mode passes a
    /// pointer to it, stores it at a fixed stack offset or stores it at a
    /// fixed location in a different address space.
    Indirect { attrs: ArgAttributes, address_space: Option<AddressSpace>, mode: IndirectMode },
    /// Pass the unsized argument indirectly via a hidden pointer.
    ///
    /// The caller places the value in memory and passes a pointer to it.
    IndirectUnsized {
        attrs: ArgAttributes,
        /// Attributes for the metadata pointer (vtable or length) of unsized arguments.
        meta_attrs: ArgAttributes,
    },
}

/// Attributes of a function argument or return value.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct ArgAttributes {
    pub(crate) regular: ArgAttributeFlags,
    pub(crate) arg_ext: ArgExtension,
    pub(crate) pointee_size: Size,
    pub(crate) pointee_align: Option<Align>,
}

impl ArgAttributes {
    /// Return the calling convention and optimization flags for this argument.
    pub fn regular(&self) -> ArgAttributeFlags {
        self.regular
    }

    /// Return how this argument should be extended when passed in a register.
    ///
    /// Relevant for integer arguments smaller than the register width.
    pub fn arg_extension(&self) -> ArgExtension {
        self.arg_ext
    }

    /// Return the minimum alignment of the pointee, if applicable.
    ///
    /// This is relevant for `PassMode::Indirect` arguments where the pointer
    /// must satisfy a particular alignment.
    pub fn pointee_align(&self) -> Option<Align> {
        self.pointee_align
    }

    /// Return the minimum dereferenceable size of the pointee, if it is non-null,
    /// at function entry (for arguments) or return (for return values).
    ///
    /// This alone does not guarantee dereferenceability for the duration of the call.
    pub fn pointee_size(&self) -> Size {
        self.pointee_size
    }
}

/// Calling convention and optimization flags for a function argument or return value.
///
/// The capture flags overlap: `captures_none` implies `captures_address`, which
/// implies `captures_read_only`.
#[non_exhaustive]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct ArgAttributeFlags {
    pub captures_none: bool,
    pub captures_address: bool,
    pub captures_read_only: bool,
    pub no_alias: bool,
    pub non_null: bool,
    pub read_only: bool,
    pub in_reg: bool,
    pub no_undef: bool,
    pub writable: bool,
    pub no_free: bool,
}

/// How a small integer argument should be extended to fill a register.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum ArgExtension {
    /// No extension required.
    None,
    /// Zero-extend to the register width.
    Zext,
    /// Sign-extend to the register width.
    Sext,
}

/// Describes the ABI type that an argument is transmuted to for `PassMode::Cast`.
///
/// When an argument is "cast," its raw bytes are reinterpreted as a sequence of
/// register-sized values for passing. This struct describes that target layout:
///
/// 1. The `prefix` registers are laid out first, like fields of a `repr(C)` struct
///    (i.e., with alignment padding between them).
/// 2. After the prefix, `rest.unit` is repeated enough times to cover `rest.total`,
///    starting at `rest_offset` (or immediately after the prefix if `None`).
///
/// For example, on x86_64 a `struct { i32, f64 }` might be cast to a prefix of
/// `[Reg::i64()]` followed by a rest of `Reg::f64()` — placing the first 8 bytes
/// in an integer register and the second 8 bytes in a floating-point register.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct CastTarget {
    /// Leading registers of potentially different types, laid out with `repr(C)` padding.
    pub prefix: Vec<Reg>,
    /// The byte offset where `rest` begins, if explicitly set.
    /// When `None`, `rest` starts immediately after the prefix.
    pub rest_offset: Option<Size>,
    /// The repeated trailing register type filling the remainder of the value.
    pub rest: Uniform,
}

impl CastTarget {
    /// Return the total size of the ABI type this argument is cast to.
    pub fn size(&self) -> Size {
        let prefix_size: usize = self.prefix.iter().map(|r| r.size.bits()).sum();
        Size::from_bits(prefix_size + self.rest.total.bits())
    }
}

/// A sequence of registers of the same kind used to pass an argument.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct Uniform {
    /// The type of register used.
    pub unit: Reg,
    /// The total size of the argument, which can be:
    /// * equal to `unit.size` (one scalar/vector),
    /// * a multiple of `unit.size` (an array of scalar/vectors),
    /// * if `unit.kind` is `Integer`, the last element can be shorter, i.e., `{ i64, i64, i32 }`
    ///   for 64-bit integers with a total size of 20 bytes. When the argument is actually passed,
    ///   this size will be rounded up to the nearest multiple of `unit.size`.
    pub total: Size,
    /// Whether the argument is consecutive: either all values are passed in registers, or all on
    /// the stack with no additional padding between elements.
    pub is_consecutive: bool,
}

impl Uniform {
    /// Return the number of registers needed to cover `total`.
    pub fn reg_count(&self) -> usize {
        if self.unit.size.bits() == 0 {
            return 0;
        }
        (self.total.bits() + self.unit.size.bits() - 1) / self.unit.size.bits()
    }
}

/// A register type used in ABI calling conventions.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct Reg {
    pub kind: RegKind,
    pub size: Size,
}

/// The kind of a register used in calling conventions.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum RegKind {
    Integer,
    Float,
    Vector,
}

/// The layout of a type, alongside the type itself.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct TyAndLayout {
    pub ty: Ty,
    pub layout: Layout,
}

/// The layout of a type, including its size, alignment, field offsets, and backend representation.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct LayoutShape {
    /// The fields location within the layout
    pub fields: FieldsShape,

    /// Encodes information about multi-variant layouts.
    /// Even with `Multiple` variants, a layout still has its own fields! Those are then
    /// shared between all variants.
    ///
    /// To access all fields of this layout, both `fields` and the fields of the active variant
    /// must be taken into account.
    pub variants: VariantsShape,

    /// A hint for how backends should represent this type: as a scalar, vector, or aggregate.
    pub value_repr: ValueRepr,

    /// The ABI mandated alignment in bytes.
    pub abi_align: Align,

    /// The size of this layout in bytes.
    pub size: Size,
}

impl LayoutShape {
    /// Returns `true` if the layout corresponds to an unsized type.
    #[inline]
    pub fn is_unsized(&self) -> bool {
        self.value_repr.is_unsized()
    }

    #[inline]
    pub fn is_sized(&self) -> bool {
        !self.value_repr.is_unsized()
    }

    /// Returns `true` if the type is sized and a 1-ZST (meaning it has size 0 and alignment 1).
    pub fn is_1zst(&self) -> bool {
        self.is_sized() && self.size.bits() == 0 && self.abi_align == 1
    }
}

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct Layout(usize, ThreadLocalIndex);
index_impl!(Layout);

impl Layout {
    pub fn shape(self) -> LayoutShape {
        with(|cx| cx.layout_shape(self))
    }
}

/// Describes the number and position of fields within a type's layout.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum FieldsShape {
    /// Scalar primitives and `!`, which never have fields.
    Primitive,

    /// All fields start at no offset. The `usize` is the field count.
    Union(NonZero<usize>),

    /// Array/vector-like placement, with all fields of identical types.
    Array { stride: Size, count: u64 },

    /// Struct-like placement, with precomputed offsets.
    ///
    /// Fields are guaranteed to not overlap, but note that gaps
    /// before, between and after all the fields are NOT always
    /// padding, and as such their contents may not be discarded.
    /// For example, enum variants leave a gap at the start,
    /// where the discriminant field in the enum layout goes.
    Arbitrary {
        /// Offsets for the first byte of each field,
        /// ordered to match the source definition order.
        /// I.e.: It follows the same order as [super::ty::VariantDef::fields()].
        /// This vector does not go in increasing order.
        offsets: Vec<Size>,
    },
}

impl FieldsShape {
    pub fn fields_by_offset_order(&self) -> Vec<FieldIdx> {
        match self {
            FieldsShape::Primitive => vec![],
            FieldsShape::Union(_) | FieldsShape::Array { .. } => (0..self.count()).collect(),
            FieldsShape::Arbitrary { offsets, .. } => {
                let mut indices = (0..offsets.len()).collect::<Vec<_>>();
                indices.sort_by_key(|idx| offsets[*idx]);
                indices
            }
        }
    }

    pub fn count(&self) -> usize {
        match self {
            FieldsShape::Primitive => 0,
            FieldsShape::Union(count) => count.get(),
            FieldsShape::Array { count, .. } => *count as usize,
            FieldsShape::Arbitrary { offsets, .. } => offsets.len(),
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum VariantsShape {
    /// A type with no valid variants. Must be uninhabited.
    Empty,

    /// Single enum variants, structs/tuples, unions, and all non-ADTs.
    Single { index: VariantIdx },

    /// Enum-likes with more than one inhabited variant: each variant comes with
    /// a *discriminant* (usually the same as the variant index but the user can
    /// assign explicit discriminant values). That discriminant is encoded
    /// as a *tag* on the machine. The layout of each variant is
    /// a struct, and they all have space reserved for the tag.
    /// For enums, the tag is the sole field of the layout.
    Multiple {
        tag: Scalar,
        tag_encoding: TagEncoding,
        tag_field: usize,
        variants: Vec<VariantFields>,
    },
}

#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct VariantFields {
    /// Offsets for the first byte of each field,
    /// ordered to match the source definition order.
    /// I.e.: It follows the same order as [super::ty::VariantDef::fields()].
    /// This vector does not go in increasing order.
    pub offsets: Vec<Size>,
}

impl VariantFields {
    pub fn fields_by_offset_order(&self) -> Vec<FieldIdx> {
        let mut indices = (0..self.offsets.len()).collect::<Vec<_>>();
        indices.sort_by_key(|idx| self.offsets[*idx]);
        indices
    }
}

#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum TagEncoding {
    /// The tag directly stores the discriminant, but possibly with a smaller layout
    /// (so converting the tag to the discriminant can require sign extension).
    Direct,

    /// Niche (values invalid for a type) encoding the discriminant:
    /// Discriminant and variant index coincide.
    /// The variant `untagged_variant` contains a niche at an arbitrary
    /// offset (field `tag_field` of the enum), which for a variant with
    /// discriminant `d` is set to
    /// `(d - niche_variants.start).wrapping_add(niche_start)`.
    ///
    /// For example, `Option<(usize, &T)>`  is represented such that
    /// `None` has a null pointer for the second tuple field, and
    /// `Some` is the identity function (with a non-null reference).
    Niche {
        untagged_variant: VariantIdx,
        niche_variants: RangeInclusive<VariantIdx>,
        niche_start: u128,
    },
}

/// The number of scalable vectors in a [`ValueRepr::ScalableVector`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub struct NumScalableVectors(pub(crate) u8);

/// A hint for how backends should represent values of this type.
///
/// Distinguishes between types representable as scalars, pairs of scalars,
/// SIMD vectors, or aggregates.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum ValueRepr {
    Scalar(Scalar),
    ScalarPair {
        a: Scalar,
        b: Scalar,
        b_offset: Size,
    },
    /// A fixed-length SIMD vector.
    Vector {
        element: Scalar,
        count: u64,
    },
    /// A scalable SIMD vector (e.g., ARM SVE).
    ScalableVector {
        element: Scalar,
        count: u64,
        number_of_vectors: NumScalableVectors,
    },
    /// The type is not representable as a scalar or vector (e.g., aggregates, unsized types).
    Aggregate {
        /// If true, the size is exact, otherwise it's only a lower bound.
        sized: bool,
    },
}

impl ValueRepr {
    /// Returns `true` if the layout corresponds to an unsized type.
    pub fn is_unsized(&self) -> bool {
        match *self {
            ValueRepr::Scalar(_)
            | ValueRepr::ScalarPair { .. }
            | ValueRepr::Vector { .. }
            // FIXME(rustc_scalable_vector): Scalable vectors are `Sized` while the
            // `sized_hierarchy` feature is not yet fully implemented. After `sized_hierarchy` is
            // fully implemented, scalable vectors will remain `Sized`, they just won't be
            // `const Sized` - whether `is_unsized` continues to return `false` at that point will
            // need to be revisited and will depend on what `is_unsized` is used for.
            | ValueRepr::ScalableVector { .. } => false,
            ValueRepr::Aggregate { sized } => !sized,
        }
    }
}

/// Information about one scalar component of a Rust type.
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Serialize)]
pub enum Scalar {
    Initialized {
        /// The primitive type used to represent this value.
        value: Primitive,
        /// The range that represents valid values.
        /// The range must be valid for the `primitive` size.
        valid_range: WrappingRange,
    },
    Union {
        /// Unions never have niches, so there is no `valid_range`.
        /// The `Primitive` type is kept to inform the backend representation
        /// and to compute the size of the scalar.
        value: Primitive,
    },
}

impl Scalar {
    pub fn has_niche(&self, target: &MachineInfo) -> bool {
        match self {
            Scalar::Initialized { value, valid_range } => {
                !valid_range.is_full(value.size(target)).unwrap()
            }
            Scalar::Union { .. } => false,
        }
    }
}

/// A primitive scalar type: integer, float, or pointer.
#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug, Serialize)]
pub enum Primitive {
    /// An integer type with a given length and signedness.
    ///
    /// Signedness matters because some calling conventions require small integers
    /// to be sign-extended or zero-extended when passed, and using the wrong
    /// extension produces incorrect values in the callee.
    Int { length: IntegerLength, signed: bool },
    /// A floating-point type with a given length.
    Float { length: FloatLength },
    /// A pointer in the given address space.
    Pointer(AddressSpace),
}

impl Primitive {
    pub fn size(self, target: &MachineInfo) -> Size {
        match self {
            Primitive::Int { length, .. } => Size::from_bits(length.bits()),
            Primitive::Float { length } => Size::from_bits(length.bits()),
            Primitive::Pointer(_) => target.pointer_width,
        }
    }
}

/// Enum representing the existing integer lengths.
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize)]
pub enum IntegerLength {
    I8,
    I16,
    I32,
    I64,
    I128,
}

/// Enum representing the existing float lengths.
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize)]
pub enum FloatLength {
    F16,
    F16B,
    F32,
    F64,
    F128,
    PpcF128,
}

impl IntegerLength {
    pub fn bits(self) -> usize {
        match self {
            IntegerLength::I8 => 8,
            IntegerLength::I16 => 16,
            IntegerLength::I32 => 32,
            IntegerLength::I64 => 64,
            IntegerLength::I128 => 128,
        }
    }
}

impl FloatLength {
    pub fn bits(self) -> usize {
        match self {
            FloatLength::F16 | FloatLength::F16B => 16,
            FloatLength::F32 => 32,
            FloatLength::F64 => 64,
            FloatLength::F128 => 128,
            FloatLength::PpcF128 => 128,
        }
    }
}

/// An identifier that specifies the address space that some operation
/// should operate on. Special address spaces have an effect on code generation,
/// depending on the target and the address spaces it implements.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize)]
pub struct AddressSpace(pub u32);

impl AddressSpace {
    /// The default address space, corresponding to data space.
    pub const DATA: Self = AddressSpace(0);
}

/// Inclusive wrap-around range of valid values (bitwise representation), that is, if
/// start > end, it represents `start..=MAX`, followed by `0..=end`.
///
/// That is, for an i8 primitive, a range of `254..=2` means following
/// sequence:
///
///    254 (-2), 255 (-1), 0, 1, 2
#[derive(Clone, Copy, PartialEq, Eq, Hash, Serialize)]
pub struct WrappingRange {
    pub start: u128,
    pub end: u128,
}

impl WrappingRange {
    /// Returns `true` if `size` completely fills the range.
    #[inline]
    pub fn is_full(&self, size: Size) -> Result<bool, Error> {
        let Some(max_value) = size.unsigned_int_max() else {
            return Err(error!("Expected size <= 128 bits, but found {} instead", size.bits()));
        };
        if self.start <= max_value && self.end <= max_value {
            Ok(self.start == (self.end.wrapping_add(1) & max_value))
        } else {
            Err(error!("Range `{self:?}` out of bounds for size `{}` bits.", size.bits()))
        }
    }

    /// Returns `true` if `v` is contained in the range.
    #[inline(always)]
    pub fn contains(&self, v: u128) -> bool {
        if self.wraps_around() {
            self.start <= v || v <= self.end
        } else {
            self.start <= v && v <= self.end
        }
    }

    /// Returns `true` if the range wraps around.
    /// I.e., the range represents the union of `self.start..=MAX` and `0..=self.end`.
    /// Returns `false` if this is a non-wrapping range, i.e.: `self.start..=self.end`.
    #[inline]
    pub fn wraps_around(&self) -> bool {
        self.start > self.end
    }
}

impl Debug for WrappingRange {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.start > self.end {
            write!(fmt, "(..={}) | ({}..)", self.end, self.start)?;
        } else {
            write!(fmt, "{}..={}", self.start, self.end)?;
        }
        Ok(())
    }
}

/// General language calling conventions.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize)]
pub enum CallConvention {
    C,
    Rust,

    Cold,
    PreserveMost,
    PreserveAll,
    PreserveNone,
    Tail,

    Custom,

    Swift,

    // Target-specific calling conventions.
    ArmAapcs,
    CCmseNonSecureCall,
    CCmseNonSecureEntry,

    Msp430Intr,

    PtxKernel,

    GpuKernel,

    X86Fastcall,
    X86Intr,
    X86Stdcall,
    X86ThisCall,
    X86VectorCall,

    X86_64SysV,
    X86_64Win64,

    AvrInterrupt,
    AvrNonBlockingInterrupt,

    RiscvInterrupt,
}

#[non_exhaustive]
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize)]
pub struct ReprFlags {
    pub is_simd: bool,
    pub is_c: bool,
    pub is_transparent: bool,
    pub is_linear: bool,
}

#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize)]
pub enum IntegerType {
    /// Pointer-sized integer type, i.e. `isize` and `usize`.
    Pointer {
        /// Signedness. e.g. `true` for `isize`
        is_signed: bool,
    },
    /// Fixed-sized integer type, e.g. `i8`, `u32`, `i128`.
    Fixed {
        /// Length of this integer type. e.g. `IntegerLength::I8` for `u8`.
        length: IntegerLength,
        /// Signedness. e.g. `false` for `u8`
        is_signed: bool,
    },
}

/// Representation options provided by the user
#[non_exhaustive]
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize)]
pub struct ReprOptions {
    pub int: Option<IntegerType>,
    pub align: Option<Align>,
    pub pack: Option<Align>,
    pub flags: ReprFlags,
}