wasmtime_environ/builtin.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
/// Helper macro to iterate over all builtin functions and their signatures.
#[macro_export]
macro_rules! foreach_builtin_function {
($mac:ident) => {
$mac! {
// Returns an index for wasm's `memory.grow` builtin function.
memory32_grow(vmctx: vmctx, delta: i64, index: i32) -> pointer;
// Returns an index for wasm's `table.copy` when both tables are locally
// defined.
table_copy(vmctx: vmctx, dst_index: i32, src_index: i32, dst: i64, src: i64, len: i64);
// Returns an index for wasm's `table.init`.
table_init(vmctx: vmctx, table: i32, elem: i32, dst: i64, src: i64, len: i64);
// Returns an index for wasm's `elem.drop`.
elem_drop(vmctx: vmctx, elem: i32);
// Returns an index for wasm's `memory.copy`
memory_copy(vmctx: vmctx, dst_index: i32, dst: i64, src_index: i32, src: i64, len: i64);
// Returns an index for wasm's `memory.fill` instruction.
memory_fill(vmctx: vmctx, memory: i32, dst: i64, val: i32, len: i64);
// Returns an index for wasm's `memory.init` instruction.
memory_init(vmctx: vmctx, memory: i32, data: i32, dst: i64, src: i32, len: i32);
// Returns a value for wasm's `ref.func` instruction.
ref_func(vmctx: vmctx, func: i32) -> pointer;
// Returns an index for wasm's `data.drop` instruction.
data_drop(vmctx: vmctx, data: i32);
// Returns a table entry after lazily initializing it.
table_get_lazy_init_func_ref(vmctx: vmctx, table: i32, index: i64) -> pointer;
// Returns an index for Wasm's `table.grow` instruction for `funcref`s.
table_grow_func_ref(vmctx: vmctx, table: i32, delta: i64, init: pointer) -> pointer;
// Returns an index for Wasm's `table.fill` instruction for `funcref`s.
table_fill_func_ref(vmctx: vmctx, table: i32, dst: i64, val: pointer, len: i64);
// Returns an index for wasm's `memory.atomic.notify` instruction.
#[cfg(feature = "threads")]
memory_atomic_notify(vmctx: vmctx, memory: i32, addr: i64, count: i32) -> i32;
// Returns an index for wasm's `memory.atomic.wait32` instruction.
#[cfg(feature = "threads")]
memory_atomic_wait32(vmctx: vmctx, memory: i32, addr: i64, expected: i32, timeout: i64) -> i32;
// Returns an index for wasm's `memory.atomic.wait64` instruction.
#[cfg(feature = "threads")]
memory_atomic_wait64(vmctx: vmctx, memory: i32, addr: i64, expected: i64, timeout: i64) -> i32;
// Invoked when fuel has run out while executing a function.
out_of_gas(vmctx: vmctx);
// Invoked when we reach a new epoch.
new_epoch(vmctx: vmctx) -> i64;
// Invoked before malloc returns.
#[cfg(feature = "wmemcheck")]
check_malloc(vmctx: vmctx, addr: i32, len: i32) -> i32;
// Invoked before the free returns.
#[cfg(feature = "wmemcheck")]
check_free(vmctx: vmctx, addr: i32) -> i32;
// Invoked before a load is executed.
#[cfg(feature = "wmemcheck")]
check_load(vmctx: vmctx, num_bytes: i32, addr: i32, offset: i32) -> i32;
// Invoked before a store is executed.
#[cfg(feature = "wmemcheck")]
check_store(vmctx: vmctx, num_bytes: i32, addr: i32, offset: i32) -> i32;
// Invoked after malloc is called.
#[cfg(feature = "wmemcheck")]
malloc_start(vmctx: vmctx);
// Invoked after free is called.
#[cfg(feature = "wmemcheck")]
free_start(vmctx: vmctx);
// Invoked when wasm stack pointer is updated.
#[cfg(feature = "wmemcheck")]
update_stack_pointer(vmctx: vmctx, value: i32);
// Invoked before memory.grow is called.
#[cfg(feature = "wmemcheck")]
update_mem_size(vmctx: vmctx, num_bytes: i32);
// Drop a non-stack GC reference (eg an overwritten table entry)
// once it will no longer be used again. (Note: `val` is not of type
// `reference` because it needn't appear in any stack maps, as it
// must not be live after this call.)
#[cfg(feature = "gc-drc")]
drop_gc_ref(vmctx: vmctx, val: i32);
// Do a GC, treating the optional `root` as a GC root and returning
// the updated `root` (so that, in the case of moving collectors,
// callers have a valid version of `root` again).
#[cfg(feature = "gc-drc")]
gc(vmctx: vmctx, root: reference) -> reference;
// Allocate a new, uninitialized GC object and return a reference to
// it.
#[cfg(feature = "gc-drc")]
gc_alloc_raw(
vmctx: vmctx,
kind: i32,
module_interned_type_index: i32,
size: i32,
align: i32
) -> reference;
// Intern a `funcref` into the GC heap, returning its
// `FuncRefTableId`.
//
// This libcall may not GC.
#[cfg(feature = "gc")]
intern_func_ref_for_gc_heap(
vmctx: vmctx,
func_ref: pointer
) -> i32;
// Get the raw `VMFuncRef` pointer associated with a
// `FuncRefTableId` from an earlier `intern_func_ref_for_gc_heap`
// call.
//
// This libcall may not GC.
//
// Passes in the `ModuleInternedTypeIndex` of the funcref's expected
// type, or `ModuleInternedTypeIndex::reserved_value()` if we are
// getting the function reference as an untyped `funcref` rather
// than a typed `(ref $ty)`.
//
// TODO: We will want to eventually expose the table directly to
// Wasm code, so that it doesn't need to make a libcall to go from
// id to `VMFuncRef`. That will be a little tricky: it will also
// require updating the pointer to the slab in the `VMContext` (or
// `VMRuntimeLimits` or wherever we put it) when the slab is
// resized.
#[cfg(feature = "gc")]
get_interned_func_ref(
vmctx: vmctx,
func_ref_id: i32,
module_interned_type_index: i32
) -> pointer;
// Builtin implementation of the `array.new_data` instruction.
#[cfg(feature = "gc")]
array_new_data(
vmctx: vmctx,
array_interned_type_index: i32,
data_index: i32,
data_offset: i32,
len: i32
) -> reference;
// Builtin implementation of the `array.new_elem` instruction.
#[cfg(feature = "gc")]
array_new_elem(
vmctx: vmctx,
array_interned_type_index: i32,
elem_index: i32,
elem_offset: i32,
len: i32
) -> reference;
// Builtin implementation of the `array.copy` instruction.
#[cfg(feature = "gc")]
array_copy(
vmctx: vmctx,
dst_array: reference,
dst_index: i32,
src_array: reference,
src_index: i32,
len: i32
);
// Builtin implementation of the `array.init_data` instruction.
#[cfg(feature = "gc")]
array_init_data(
vmctx: vmctx,
array_interned_type_index: i32,
array: reference,
dst_index: i32,
data_index: i32,
data_offset: i32,
len: i32
);
// Builtin implementation of the `array.init_elem` instruction.
#[cfg(feature = "gc")]
array_init_elem(
vmctx: vmctx,
array_interned_type_index: i32,
array: reference,
dst: i32,
elem_index: i32,
src: i32,
len: i32
);
// Returns whether `actual_engine_type` is a subtype of
// `expected_engine_type`.
#[cfg(feature = "gc")]
is_subtype(
vmctx: vmctx,
actual_engine_type: i32,
expected_engine_type: i32
) -> i32;
// Returns an index for Wasm's `table.grow` instruction for GC references.
#[cfg(feature = "gc")]
table_grow_gc_ref(vmctx: vmctx, table: i32, delta: i64, init: reference) -> pointer;
// Returns an index for Wasm's `table.fill` instruction for GC references.
#[cfg(feature = "gc")]
table_fill_gc_ref(vmctx: vmctx, table: i32, dst: i64, val: reference, len: i64);
// Raises an unconditional trap.
trap(vmctx: vmctx, code: u8);
// Implementation of `i{32,64}.trunc_f{32,64}_{u,s}` when host trap
// handlers are disabled. These will raise a trap if necessary. Note
// that f32 inputs are always converted to f64 as the argument. Also
// note that the signed-ness of the result is not reflected in the
// type here.
f64_to_i64(vmctx: vmctx, float: f64) -> i64;
f64_to_u64(vmctx: vmctx, float: f64) -> i64;
f64_to_i32(vmctx: vmctx, float: f64) -> i32;
f64_to_u32(vmctx: vmctx, float: f64) -> i32;
}
};
}
/// An index type for builtin functions.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct BuiltinFunctionIndex(u32);
impl BuiltinFunctionIndex {
/// Create a new `BuiltinFunctionIndex` from its index
pub const fn from_u32(i: u32) -> Self {
Self(i)
}
/// Return the index as an u32 number.
pub const fn index(&self) -> u32 {
self.0
}
}
macro_rules! declare_indexes {
(
$(
$( #[$attr:meta] )*
$name:ident( $( $pname:ident: $param:ident ),* ) $( -> $result:ident )?;
)*
) => {
impl BuiltinFunctionIndex {
declare_indexes!(
@indices;
0;
$( $( #[$attr] )* $name; )*
);
/// Returns a symbol name for this builtin.
pub fn name(&self) -> &'static str {
$(
$( #[$attr] )*
if *self == BuiltinFunctionIndex::$name() {
return stringify!($name);
}
)*
unreachable!()
}
}
};
// Base case: no more indices to declare, so define the total number of
// function indices.
(
@indices;
$len:expr;
) => {
/// Returns the total number of builtin functions.
pub const fn builtin_functions_total_number() -> u32 {
$len
}
};
// Recursive case: declare the next index, and then keep declaring the rest of
// the indices.
(
@indices;
$index:expr;
$( #[$this_attr:meta] )*
$this_name:ident;
$(
$( #[$rest_attr:meta] )*
$rest_name:ident;
)*
) => {
$( #[$this_attr] )*
#[allow(missing_docs)]
pub const fn $this_name() -> Self {
Self($index)
}
declare_indexes!(
@indices;
($index + 1);
$( $( #[$rest_attr] )* $rest_name; )*
);
}
}
foreach_builtin_function!(declare_indexes);