@ -1,15 +1,41 @@
//! Trampoline implementation for Winch.
//!
//! This module contains all the necessary pieces to emit the various
//! trampolines required by Wasmtime to call JIT code.
//
// TODO
//
// * Remove the usage of hardcoded operand sizes (`OperandSize::S64`) when
// loading/storing the VM context pointer. The real value of the operand size
// and VM context type should be derived from the ABI's pointer size. This is
// going to be relevant once 32-bit architectures are supported.
//
// * Save the fp and pc for fast stack walking.
use crate ::{
use crate ::{
abi ::{ align_to , calculate_frame_adjustment , ABIArg , ABIResult , ABI } ,
abi ::{ ABIArg , ABIParams , ABIResult , ABISig , ABI } ,
isa ::CallingConvention ,
isa ::CallingConvention ,
masm ::{ CalleeKind , MacroAssembler , OperandSize , RegImm } ,
masm ::{ CalleeKind , MacroAssembler , OperandSize , RegImm } ,
reg ::Reg ,
reg ::Reg ,
} ;
} ;
use anyhow ::{ anyhow , Result } ;
use smallvec ::SmallVec ;
use smallvec ::SmallVec ;
use std ::mem ;
use std ::mem ;
use wasmparser ::{ FuncType , ValType } ;
use wasmparser ::{ FuncType , ValType } ;
use wasmtime_environ ::{ FuncIndex , PtrSize } ;
/// A trampoline to provide interopt between different calling
/// The supported trampoline kinds.
/// conventions.
/// See https://github.com/bytecodealliance/rfcs/blob/main/accepted/tail-calls.md#new-trampolines-and-vmcallercheckedanyfunc-changes
/// for more details.
pub enum TrampolineKind {
/// Calling from native to Wasm, using the array calling convention.
ArrayToWasm ( FuncIndex ) ,
/// Calling from native to Wasm.
NativeToWasm ( FuncIndex ) ,
/// Calling from Wasm to native.
WasmToNative ,
}
/// The main trampoline abstraction.
pub ( crate ) struct Trampoline < 'a , A , M >
pub ( crate ) struct Trampoline < 'a , A , M >
where
where
A : ABI ,
A : ABI ,
@ -26,12 +52,15 @@ where
/// callee, so it can only be used after the callee-saved
/// callee, so it can only be used after the callee-saved
/// registers are on the stack.
/// registers are on the stack.
alloc_scratch_reg : Reg ,
alloc_scratch_reg : Reg ,
/// Registers to be saved as part of the trampoline's prologue and epilogue.
/// Registers to be saved as part of the trampoline's prologue
/// and to be restored as part of the trampoline's epilogue.
callee_saved_regs : SmallVec < [ Reg ; 9 ] > ,
callee_saved_regs : SmallVec < [ Reg ; 9 ] > ,
/// The calling convention used by the trampoline,
/// The calling convention used by the trampoline,
/// which is the Wasmtime variant of the system ABI's
/// which is the Wasmtime variant of the system ABI's
/// calling convention.
/// calling convention.
call_conv : & 'a CallingConvention ,
call_conv : & 'a CallingConvention ,
/// The pointer size of the current ISA.
pointer_size : u8 ,
}
}
impl < 'a , A , M > Trampoline < 'a , A , M >
impl < 'a , A , M > Trampoline < 'a , A , M >
@ -46,6 +75,7 @@ where
scratch_reg : Reg ,
scratch_reg : Reg ,
alloc_scratch_reg : Reg ,
alloc_scratch_reg : Reg ,
call_conv : & 'a CallingConvention ,
call_conv : & 'a CallingConvention ,
pointer_size : u8 ,
) -> Self {
) -> Self {
Self {
Self {
masm ,
masm ,
@ -54,147 +84,320 @@ where
alloc_scratch_reg ,
alloc_scratch_reg ,
callee_saved_regs : < A as ABI > ::callee_saved_regs ( call_conv ) ,
callee_saved_regs : < A as ABI > ::callee_saved_regs ( call_conv ) ,
call_conv ,
call_conv ,
pointer_size ,
}
}
}
}
/// Emit the host to wasm trampoline.
/// Emit an array-to-wasm trampoline.
pub fn emit_host_to_wasm ( & mut self , ty : & FuncType ) {
pub fn emit_array_to_wasm ( & mut self , ty : & FuncType , callee_index : FuncIndex ) -> Result < ( ) > {
// The host to wasm trampoline is currently hard coded (see vmcontext.rs
let native_ty = FuncType ::new (
// in the wasmtime-runtime crate, `VMArrayCallFunction`). The first two
// parameters are VMContexts (not used at this time). The third
// parameter is the function pointer to call. The fourth parameter is
// an address to storage space for both the return value and the
// arguments to the function.
let trampoline_ty = FuncType ::new (
vec ! [ ValType ::I64 , ValType ::I64 , ValType ::I64 , ValType ::I64 ] ,
vec ! [ ValType ::I64 , ValType ::I64 , ValType ::I64 , ValType ::I64 ] ,
vec ! [ ] ,
vec ! [ ] ,
) ;
) ;
let trampoline_sig = self . abi . sig ( & trampoline_ty , self . call_conv ) ;
let native_sig = self . native_sig ( & native_ty ) ;
let wasm_sig = self . wasm_sig ( ty ) ;
// Hard-coding the size in bytes of the trampoline arguments
let val_ptr = & native_sig . params [ 2 ]
// since it's static, based on the current signature we should
. get_reg ( )
// always have 4 arguments, each of which is 8 bytes.
. map ( RegImm ::reg )
let trampoline_arg_size = 32 ;
. ok_or_else ( | | anyhow ! ( "Expected value pointer to be in a register" ) ) ? ;
let callee_sig = self . abi . sig ( ty , & CallingConvention ::Default ) ;
self . prologue_with_callee_saved ( ) ;
let val_ptr = if let ABIArg ::Reg { reg , ty : _ty } = & trampoline_sig . params [ 3 ] {
// Get the VM context pointer and move it to the designated pinned
Ok ( RegImm ::reg ( * reg ) )
// register.
} else {
let vmctx_ptr = Self ::vmctx ( & native_sig . params ) ? ;
Err ( anyhow ::anyhow ! ( "Expected the val ptr to be in a register" ) )
self . masm
}
. mov ( vmctx_ptr , < A as ABI > ::vmctx_reg ( ) . into ( ) , OperandSize ::S64 ) ;
. unwrap ( ) ;
self . prologue ( ) ;
let ( offsets , spill_size ) = self . spill ( & native_sig . params ) ;
let mut trampoline_arg_offsets : [ u32 ; 4 ] = [ 0 ; 4 ] ;
let val_ptr_offset = offsets [ 2 ] ;
trampoline_sig
// Call the function that was passed into the trampoline.
. params
let allocated_stack = self . masm . call (
. iter ( )
self . abi . call_stack_align ( ) . into ( ) ,
. enumerate ( )
self . abi . arg_base_offset ( ) . into ( ) ,
. for_each ( | ( i , param ) | {
wasm_sig . stack_bytes ,
if let ABIArg ::Reg { reg , ty : _ty } = param {
| masm | {
let offset = self . masm . push ( * reg ) ;
masm . mov ( * val_ptr , self . scratch_reg . into ( ) , OperandSize ::S64 ) ;
trampoline_arg_offsets [ i ] = offset ;
Self ::assign_args_from_array (
masm ,
& wasm_sig ,
self . scratch_reg ,
self . alloc_scratch_reg ,
) ;
CalleeKind ::Direct ( callee_index . as_u32 ( ) )
} ,
) ;
self . masm . free_stack ( allocated_stack ) ;
// Move the val ptr back into the scratch register so we can
// load the return values.
self . masm . load (
self . masm . address_from_sp ( val_ptr_offset ) ,
self . scratch_reg ,
OperandSize ::S64 ,
) ;
// Move the return values into the value ptr. We are only
// supporting a single return value at this time.
let ABIResult ::Reg { reg , ty } = & wasm_sig . result ;
if let Some ( ty ) = ty {
self . masm . store (
RegImm ::reg ( * reg ) ,
self . masm . address_at_reg ( self . scratch_reg , 0 ) ,
( * ty ) . into ( ) ,
) ;
}
self . epilogue_with_callee_saved_restore ( spill_size ) ;
Ok ( ( ) )
}
}
} ) ;
let val_ptr_offset = trampoline_arg_offsets [ 3 ] ;
/// Emit a native-to-wasm trampoline.
let func_ptr_offset = trampoline_arg_offsets [ 2 ] ;
pub fn emit_native_to_wasm ( & mut self , ty : & FuncType , callee_index : FuncIndex ) -> Result < ( ) > {
let native_sig = self . native_sig ( & ty ) ;
let wasm_sig = self . wasm_sig ( & ty ) ;
let vmctx_ptr = Self ::vmctx ( & native_sig . params ) ? ;
self . prologue_with_callee_saved ( ) ;
// Move the VM context pointer to the designated pinned register.
self . masm
self . masm
. mov ( val_ptr , RegImm ::reg ( self . scratch_reg ) , OperandSize ::S64 ) ;
. mov ( vmctx_ptr , < A as ABI > ::vmctx_reg ( ) . into ( ) , OperandSize ::S64 ) ;
// How much we need to adjust the stack pointer by to account
let ( offsets , spill_size ) = self . spill ( & native_sig . params ) ;
// for the alignment required by the ISA.
let delta = calculate_frame_adjustment (
let reserved_stack = self . masm . call (
self . masm . sp_offset ( ) ,
self . abi . call_stack_align ( ) . into ( ) ,
self . abi . arg_base_offset ( ) as u32 ,
self . abi . arg_base_offset ( ) . into ( ) ,
self . abi . call_stack_align ( ) as u32 ,
wasm_sig . stack_bytes ,
| masm | {
Self ::assign_args (
masm ,
& wasm_sig . params ,
& native_sig . params [ 2 . . ] ,
& offsets [ 2 . . ] ,
self . scratch_reg ,
self . abi . arg_base_offset ( ) . into ( ) ,
) ;
CalleeKind ::Direct ( callee_index . as_u32 ( ) )
} ,
) ;
self . masm . free_stack ( reserved_stack ) ;
self . epilogue_with_callee_saved_restore ( spill_size ) ;
Ok ( ( ) )
}
/// Emit a wasm-to-native trampoline.
pub fn emit_wasm_to_native ( & mut self , ty : & FuncType ) -> Result < ( ) > {
let mut params = Self ::callee_and_caller_vmctx ( ) ;
params . extend_from_slice ( ty . params ( ) ) ;
let func_ty = FuncType ::new ( params , ty . results ( ) . to_owned ( ) ) ;
let wasm_sig = self . wasm_sig ( & func_ty ) ;
let native_sig = self . native_sig ( ty ) ;
self . prologue ( ) ;
let ( offsets , spill_size ) = self . spill ( & wasm_sig . params ) ;
let reserved_stack = self . masm . call (
self . abi . call_stack_align ( ) . into ( ) ,
self . abi . arg_base_offset ( ) . into ( ) ,
native_sig . stack_bytes ,
| masm | {
// Move the VM context into one of the scratch registers.
let vmctx = Self ::vmctx ( & wasm_sig . params ) . unwrap ( ) ;
masm . mov (
vmctx . into ( ) ,
self . alloc_scratch_reg . into ( ) ,
OperandSize ::S64 ,
) ;
Self ::assign_args (
masm ,
& native_sig . params ,
& wasm_sig . params ,
& offsets ,
self . scratch_reg ,
self . abi . arg_base_offset ( ) . into ( ) ,
) ;
) ;
// The total amount of stack space we need to reserve for the
let body_offset = self . pointer_size . vmnative_call_host_func_context_func_ref ( )
// arguments.
+ self . pointer_size . vm_func_ref_native_call ( ) ;
let total_arg_stack_space = align_to (
let callee_addr = masm . address_at_reg ( self . alloc_scratch_reg , body_offset . into ( ) ) ;
callee_sig . stack_bytes + delta ,
masm . load ( callee_addr , self . scratch_reg , OperandSize ::S64 ) ;
self . abi . call_stack_align ( ) as u32 ,
CalleeKind ::Indirect ( self . scratch_reg )
} ,
) ;
) ;
self . masm . reserve_stack ( total_arg_stack_space ) ;
self . masm . free_stack ( reserved_stack ) ;
self . epilogue ( spill_size ) ;
Ok ( ( ) )
}
/// Perfom argument assignment, translating between
/// caller and callee calling conventions.
fn assign_args (
masm : & mut M ,
callee_params : & [ ABIArg ] ,
caller_params : & [ ABIArg ] ,
caller_stack_offsets : & [ u32 ] ,
scratch : Reg ,
arg_base_offset : u32 ,
) {
assert ! ( callee_params . len ( ) = = caller_params . len ( ) ) ;
let fp = < A as ABI > ::fp_reg ( ) ;
let mut offset_index = 0 ;
callee_params
. iter ( )
. zip ( caller_params )
. for_each (
| ( callee_param , caller_param ) | match ( callee_param , caller_param ) {
( ABIArg ::Reg { ty , reg : dst } , ABIArg ::Reg { . . } ) = > {
let offset = caller_stack_offsets [ offset_index ] ;
let addr = masm . address_from_sp ( offset ) ;
masm . load ( addr , * dst , ( * ty ) . into ( ) ) ;
offset_index + = 1 ;
}
( ABIArg ::Stack { ty , offset } , ABIArg ::Reg { . . } ) = > {
let spill_offset = caller_stack_offsets [ offset_index ] ;
let addr = masm . address_from_sp ( spill_offset ) ;
masm . load ( addr , scratch , ( * ty ) . into ( ) ) ;
let arg_addr = masm . address_at_sp ( * offset ) ;
masm . store ( scratch . into ( ) , arg_addr , ( * ty ) . into ( ) ) ;
offset_index + = 1 ;
}
( ABIArg ::Reg { ty , reg : dst } , ABIArg ::Stack { ty : _ , offset } ) = > {
let addr = masm . address_at_reg ( fp , arg_base_offset + offset ) ;
masm . load ( addr , * dst , ( * ty ) . into ( ) ) ;
}
(
ABIArg ::Stack {
ty ,
offset : callee_offset ,
} ,
ABIArg ::Stack {
offset : caller_offset ,
. .
} ,
) = > {
let addr = masm . address_at_reg ( fp , arg_base_offset + caller_offset ) ;
masm . load ( addr , scratch , ( * ty ) . into ( ) ) ;
let arg_addr = masm . address_at_sp ( * callee_offset ) ;
masm . store ( scratch . into ( ) , arg_addr , ( * ty ) . into ( ) ) ;
}
} ,
)
}
/// Get the type of the caller and callee VM contexts.
fn callee_and_caller_vmctx ( ) -> Vec < ValType > {
vec ! [ ValType ::I64 , ValType ::I64 ]
}
/// Returns a signature using the system's calling convention.
fn native_sig ( & self , ty : & FuncType ) -> ABISig {
let mut params = Self ::callee_and_caller_vmctx ( ) ;
params . extend_from_slice ( ty . params ( ) ) ;
let native_type = FuncType ::new ( params , ty . results ( ) . to_owned ( ) ) ;
self . abi . sig ( & native_type , self . call_conv )
}
/// Returns a signature using the Winch's default calling convention.
fn wasm_sig ( & self , ty : & FuncType ) -> ABISig {
self . abi . sig ( ty , & CallingConvention ::Default )
}
/// Returns the register containing the VM context pointer.
fn vmctx ( params : & ABIParams ) -> Result < RegImm > {
params [ 0 ]
. get_reg ( )
. map ( RegImm ::reg )
. ok_or_else ( | | anyhow ! ( "Expected vm context pointer to be in a register" ) )
}
/// Performs a spill of the register params.
fn spill ( & mut self , params : & ABIParams ) -> ( SmallVec < [ u32 ; 6 ] > , u32 ) {
let mut offsets = SmallVec ::new ( ) ;
let mut spilled = 0 ;
params . iter ( ) . for_each ( | param | {
if let Some ( reg ) = param . get_reg ( ) {
let offset = self . masm . push ( reg ) ;
offsets . push ( offset ) ;
spilled + = 1 ;
}
} ) ;
// The stack size for the spill, calculated
// from the number of spilled register times
// the size of each push (8 bytes).
let size = spilled * < A as ABI > ::word_bytes ( ) ;
( offsets , size )
}
/// Assigns arguments for the callee, loading them from a register.
fn assign_args_from_array ( masm : & mut M , callee_sig : & ABISig , values_reg : Reg , scratch : Reg ) {
// The max size a value can be when reading from the params
// The max size a value can be when reading from the params
// memory location.
// memory location.
let value_size = mem ::size_of ::< u128 > ( ) ;
let value_size = mem ::size_of ::< u128 > ( ) ;
callee_sig . params . iter ( ) . enumerate ( ) . for_each ( | ( i , param ) | {
callee_sig . params . iter ( ) . enumerate ( ) . for_each ( | ( i , param ) | {
let value_offset = ( i * value_size ) as u32 ;
let value_offset = ( i * value_size ) as u32 ;
match param {
match param {
ABIArg ::Reg { reg , ty } = > self . masm . load (
ABIArg ::Reg { reg , ty } = > masm . load (
self . masm . address_from_reg ( self . scratch_reg , value_offset ) ,
masm . address_at_reg ( values _reg , value_offset ) ,
* reg ,
* reg ,
( * ty ) . into ( ) ,
( * ty ) . into ( ) ,
) ,
) ,
ABIArg ::Stack { offset , ty } = > {
ABIArg ::Stack { offset , ty } = > {
self . masm . load (
masm . load (
self . masm . address_from_reg ( self . scratch_reg , value_offset ) ,
masm . address_at_reg ( values _reg , value_offset ) ,
self . alloc_scratch_reg ,
scratch ,
( * ty ) . into ( ) ,
( * ty ) . into ( ) ,
) ;
) ;
self . masm . store (
masm . store (
RegImm ::reg ( self . alloc_scratch_reg ) ,
RegImm ::reg ( scratch ) ,
self . masm . address_at_sp ( * offset ) ,
masm . address_at_sp ( * offset ) ,
( * ty ) . into ( ) ,
( * ty ) . into ( ) ,
) ;
) ;
}
}
}
}
} ) ;
} ) ;
// Move the function pointer from it's stack location into a
// scratch register.
self . masm . load (
self . masm . address_from_sp ( func_ptr_offset ) ,
self . scratch_reg ,
OperandSize ::S64 ,
) ;
// Call the function that was passed into the trampoline.
self . masm . call ( CalleeKind ::Indirect ( self . scratch_reg ) ) ;
self . masm . free_stack ( total_arg_stack_space ) ;
// Move the val ptr back into the scratch register so we can
// load the return values.
self . masm . load (
self . masm . address_from_sp ( val_ptr_offset ) ,
self . scratch_reg ,
OperandSize ::S64 ,
) ;
// Move the return values into the value ptr. We are only
// supporting a single return value at this time.
let ABIResult ::Reg { reg , ty } = & callee_sig . result ;
self . masm . store (
RegImm ::reg ( * reg ) ,
self . masm . address_from_reg ( self . scratch_reg , 0 ) ,
( * ty ) . unwrap ( ) . into ( ) ,
) ;
self . epilogue ( trampoline_arg_size ) ;
}
}
/// The trampoline's prologue.
/// The trampoline's prologue.
fn prologue ( & mut self ) {
fn prologue ( & mut self ) {
self . masm . prologue ( ) ;
self . masm . prologue ( ) ;
}
/// Similar to [Trampoline::prologue], but saves
/// callee-saved registers.
fn prologue_with_callee_saved ( & mut self ) {
self . masm . prologue ( ) ;
// Save any callee-saved registers.
// Save any callee-saved registers.
for r in & self . callee_saved_regs {
for r in & self . callee_saved_regs {
self . masm . push ( * r ) ;
self . masm . push ( * r ) ;
}
}
}
}
/// The trampoline's epilogue.
/// Similar to [Trampoline::epilogue], but restores
fn epilogue ( & mut self , arg_size : u32 ) {
/// callee-saved registers.
fn epilogue_with_callee_saved_restore ( & mut self , arg_size : u32 ) {
// Free the stack space allocated by pushing the trampoline arguments.
// Free the stack space allocated by pushing the trampoline arguments.
self . masm . free_stack ( arg_size ) ;
self . masm . free_stack ( arg_size ) ;
// Restore the callee-saved registers.
// Restore the callee-saved registers.
@ -203,4 +406,11 @@ where
}
}
self . masm . epilogue ( 0 ) ;
self . masm . epilogue ( 0 ) ;
}
}
/// The trampoline's epilogue.
fn epilogue ( & mut self , arg_size : u32 ) {
// Free the stack space allocated by pushing the trampoline arguments.
self . masm . free_stack ( arg_size ) ;
self . masm . epilogue ( 0 ) ;
}
}
}