lower-ir-utils 0.1.0

//! Traits describing how Rust types map onto Cranelift's ABI.
//!
//! [`JitParam`] is type-level: it answers "what `AbiParam`s does this Rust type
//! contribute to a Cranelift `Signature`?". [`JitArg`] is value-level: it answers
//! "how do I lower this Rust value into one or more Cranelift `Value`s at a call site?".
//!
//! The two traits are intentionally independent — at a call site some arguments
//! come from already-lowered IR `Value`s (function parameters, prior instructions)
//! while others are constants embedded into the IR. The macros do not enforce a
//! correspondence between the signature types and the argument expressions; that
//! is the caller's responsibility, exactly as it would be for `bcx.ins().call`.

use cranelift_codegen::ir::{types, AbiParam, InstBuilder, Type, Value};
use cranelift_frontend::FunctionBuilder;
use smallvec::SmallVec;

/// Type-level mapping: a Rust type expands into zero or more Cranelift `AbiParam`s.
///
/// # Safety
///
/// Implementations must be self-consistent with [`JitArg`]: the number and types
/// of `AbiParam`s pushed must match the number and types of `Value`s that the
/// corresponding `JitArg::lower` implementation would emit.
pub trait JitParam {
    /// Append this type's parameters to `out`.
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type);
}

/// Value-level mapping: a Rust value lowers into zero or more Cranelift `Value`s.
///
/// Implementations are provided for already-lowered `Value`s (passthrough),
/// integer/float constants (emitted as `iconst`/`f64const`), `&'static str`
/// (emitted as ptr+len constants), and raw pointers (emitted as `iconst`).
pub trait JitArg {
    /// Lower `self` into one or more cranelift values, appended to `out`.
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>);
}

// ---------- JitParam impls ----------

impl JitParam for () {
    fn push_params(_out: &mut Vec<AbiParam>, _ptr_ty: Type) {}
}

macro_rules! impl_jit_param_scalar {
    ($($t:ty => $cl:expr),* $(,)?) => {
        $(
            impl JitParam for $t {
                fn push_params(out: &mut Vec<AbiParam>, _ptr_ty: Type) {
                    out.push(AbiParam::new($cl));
                }
            }
        )*
    };
}

impl_jit_param_scalar! {
    i8  => types::I8,
    u8  => types::I8,
    i16 => types::I16,
    u16 => types::I16,
    i32 => types::I32,
    u32 => types::I32,
    i64 => types::I64,
    u64 => types::I64,
    f32 => types::F32,
    f64 => types::F64,
    bool => types::I8,
}

macro_rules! impl_jit_param_pointerlike {
    ($($t:ty),* $(,)?) => {
        $(
            impl JitParam for $t {
                fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
                    out.push(AbiParam::new(ptr_ty));
                }
            }
        )*
    };
}

impl_jit_param_pointerlike!(usize, isize);

impl<T: Sized> JitParam for *const T {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
    }
}

impl<T: Sized> JitParam for *mut T {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
    }
}

impl<T: Sized> JitParam for &T {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
    }
}

impl<T: Sized> JitParam for &mut T {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
    }
}

impl JitParam for &str {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
        out.push(AbiParam::new(ptr_ty));
    }
}

impl<T: Sized> JitParam for &[T] {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
        out.push(AbiParam::new(ptr_ty));
    }
}

impl<T: Sized> JitParam for &mut [T] {
    fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
        out.push(AbiParam::new(ptr_ty));
        out.push(AbiParam::new(ptr_ty));
    }
}

// Tuple impls let users express multi-value returns (or grouped params) as
// `fn(...) -> (T1, T2)`. Each element contributes its own params in order.
macro_rules! impl_jit_param_tuple {
    ($($t:ident),+) => {
        impl<$($t: JitParam),+> JitParam for ($($t,)+) {
            fn push_params(out: &mut Vec<AbiParam>, ptr_ty: Type) {
                $( <$t as JitParam>::push_params(out, ptr_ty); )+
            }
        }
    };
}

impl_jit_param_tuple!(T1, T2);
impl_jit_param_tuple!(T1, T2, T3);
impl_jit_param_tuple!(T1, T2, T3, T4);
impl_jit_param_tuple!(T1, T2, T3, T4, T5);
impl_jit_param_tuple!(T1, T2, T3, T4, T5, T6);

// ---------- JitArg impls ----------

impl JitArg for Value {
    fn lower(self, _bcx: &mut FunctionBuilder, _ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(self);
    }
}

impl<const N: usize> JitArg for [Value; N] {
    fn lower(self, _bcx: &mut FunctionBuilder, _ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.extend(self);
    }
}

macro_rules! impl_jit_arg_iconst {
    ($($t:ty => $cl:expr),* $(,)?) => {
        $(
            impl JitArg for $t {
                fn lower(self, bcx: &mut FunctionBuilder, _ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
                    out.push(bcx.ins().iconst($cl, self as i64));
                }
            }
        )*
    };
}

impl_jit_arg_iconst! {
    i8  => types::I8,
    u8  => types::I8,
    i16 => types::I16,
    u16 => types::I16,
    i32 => types::I32,
    u32 => types::I32,
    i64 => types::I64,
    u64 => types::I64,
    bool => types::I8,
}

impl JitArg for usize {
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().iconst(ptr_ty, self as i64));
    }
}

impl JitArg for isize {
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().iconst(ptr_ty, self as i64));
    }
}

impl JitArg for f32 {
    fn lower(self, bcx: &mut FunctionBuilder, _ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().f32const(self));
    }
}

impl JitArg for f64 {
    fn lower(self, bcx: &mut FunctionBuilder, _ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().f64const(self));
    }
}

impl<T: Sized> JitArg for *const T {
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().iconst(ptr_ty, self as i64));
    }
}

impl<T: Sized> JitArg for *mut T {
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().iconst(ptr_ty, self as i64));
    }
}

/// Embeds the string's data pointer and length as IR constants.
///
/// The string must outlive every invocation of the JIT-compiled function.
impl JitArg for &'static str {
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().iconst(ptr_ty, self.as_ptr() as i64));
        out.push(bcx.ins().iconst(ptr_ty, self.len() as i64));
    }
}

/// Embeds the slice's data pointer and length as IR constants.
///
/// The slice must outlive every invocation of the JIT-compiled function.
impl<T: Sized> JitArg for &'static [T] {
    fn lower(self, bcx: &mut FunctionBuilder, ptr_ty: Type, out: &mut SmallVec<[Value; 8]>) {
        out.push(bcx.ins().iconst(ptr_ty, self.as_ptr() as i64));
        out.push(bcx.ins().iconst(ptr_ty, self.len() as i64));
    }
}