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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
use crate::{core::ValType, func::FuncError, Val};
use core::fmt;
use std::{sync::Arc, vec::Vec};
/// A function type representing a function's parameter and result types.
///
/// # Note
///
/// Can be cloned cheaply.
#[derive(Clone, PartialOrd, Ord, PartialEq, Eq, Hash)]
pub struct FuncType {
/// The inner function type internals.
inner: FuncTypeInner,
}
/// Internal details of [`FuncType`].
#[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq, Hash)]
pub enum FuncTypeInner {
/// Stores the value types of the parameters and results inline.
Inline {
/// The number of parameters.
len_params: u8,
/// The number of results.
len_results: u8,
/// The parameter types, followed by the result types, followed by unspecified elements.
params_results: [ValType; Self::INLINE_SIZE],
},
/// Stores the value types of the parameters and results on the heap.
Big {
/// The number of parameters.
len_params: u32,
/// Combined parameter and result types allocated on the heap.
params_results: Arc<[ValType]>,
},
}
impl FuncTypeInner {
/// The inline buffer size on 32-bit platforms.
///
/// # Note
///
/// On 32-bit platforms we target a `size_of<FuncTypeInner>()` of 16 bytes.
#[cfg(target_pointer_width = "32")]
const INLINE_SIZE: usize = 14;
/// The inline buffer size on 64-bit platforms.
///
/// # Note
///
/// On 64-bit platforms we target a `size_of<FuncTypeInner>()` of 24 bytes.
#[cfg(target_pointer_width = "64")]
const INLINE_SIZE: usize = 21;
/// Creates a new [`FuncTypeInner`].
///
/// # Panics
///
/// If an out of bounds number of parameters or results are given.
pub fn new<P, R>(params: P, results: R) -> Self
where
P: IntoIterator,
R: IntoIterator,
<P as IntoIterator>::IntoIter: Iterator<Item = ValType> + ExactSizeIterator,
<R as IntoIterator>::IntoIter: Iterator<Item = ValType> + ExactSizeIterator,
{
let mut params = params.into_iter();
let mut results = results.into_iter();
let len_params = params.len();
let len_results = results.len();
if let Some(small) = Self::try_new_small(&mut params, &mut results) {
return small;
}
let mut params_results = params.collect::<Vec<_>>();
let len_params = u32::try_from(params_results.len()).unwrap_or_else(|_| {
panic!("out of bounds parameters (={len_params}) and results (={len_results}) for FuncType")
});
params_results.extend(results);
Self::Big {
params_results: params_results.into(),
len_params,
}
}
/// Tries to create a [`FuncTypeInner::Inline`] variant from the given inputs.
///
/// # Note
///
/// - Returns `None` if creation was not possible.
/// - Does not mutate `params` or `results` if this method returns `None`.
pub fn try_new_small<P, R>(params: &mut P, results: &mut R) -> Option<Self>
where
P: Iterator<Item = ValType> + ExactSizeIterator,
R: Iterator<Item = ValType> + ExactSizeIterator,
{
let params = params.into_iter();
let results = results.into_iter();
let len_params = u8::try_from(params.len()).ok()?;
let len_results = u8::try_from(results.len()).ok()?;
let len = len_params.checked_add(len_results)?;
if usize::from(len) > Self::INLINE_SIZE {
return None;
}
let mut params_results = [ValType::I32; Self::INLINE_SIZE];
params_results
.iter_mut()
.zip(params.chain(results))
.for_each(|(cell, param_or_result)| {
*cell = param_or_result;
});
Some(Self::Inline {
len_params,
len_results,
params_results,
})
}
/// Returns the parameter types of the function type.
pub fn params(&self) -> &[ValType] {
match self {
FuncTypeInner::Inline {
len_params,
params_results,
..
} => ¶ms_results[..usize::from(*len_params)],
FuncTypeInner::Big {
len_params,
params_results,
} => ¶ms_results[..(*len_params as usize)],
}
}
/// Returns the result types of the function type.
pub fn results(&self) -> &[ValType] {
match self {
FuncTypeInner::Inline {
len_params,
len_results,
params_results,
..
} => {
let start_results = usize::from(*len_params);
let end_results = start_results + usize::from(*len_results);
¶ms_results[start_results..end_results]
}
FuncTypeInner::Big {
len_params,
params_results,
} => ¶ms_results[(*len_params as usize)..],
}
}
/// Returns the number of result types of the function type.
pub fn len_results(&self) -> usize {
match self {
FuncTypeInner::Inline { len_results, .. } => usize::from(*len_results),
FuncTypeInner::Big {
len_params,
params_results,
} => {
let len_buffer = params_results.len();
let len_params = *len_params as usize;
len_buffer - len_params
}
}
}
/// Returns the pair of parameter and result types of the function type.
pub(crate) fn params_results(&self) -> (&[ValType], &[ValType]) {
match self {
FuncTypeInner::Inline {
len_params,
len_results,
params_results,
} => {
let len_params = usize::from(*len_params);
let len_results = usize::from(*len_results);
params_results[..len_params + len_results].split_at(len_params)
}
FuncTypeInner::Big {
len_params,
params_results,
} => params_results.split_at(*len_params as usize),
}
}
}
#[test]
fn size_of_func_type() {
#[cfg(target_pointer_width = "32")]
assert!(core::mem::size_of::<FuncTypeInner>() <= 16);
#[cfg(target_pointer_width = "64")]
assert!(core::mem::size_of::<FuncTypeInner>() <= 24);
}
impl fmt::Debug for FuncType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("FuncType")
.field("params", &self.params())
.field("results", &self.results())
.finish()
}
}
impl FuncType {
/// Creates a new [`FuncType`].
pub fn new<P, R>(params: P, results: R) -> Self
where
P: IntoIterator,
R: IntoIterator,
<P as IntoIterator>::IntoIter: Iterator<Item = ValType> + ExactSizeIterator,
<R as IntoIterator>::IntoIter: Iterator<Item = ValType> + ExactSizeIterator,
{
Self {
inner: FuncTypeInner::new(params, results),
}
}
/// Returns the parameter types of the function type.
pub fn params(&self) -> &[ValType] {
self.inner.params()
}
/// Returns the result types of the function type.
pub fn results(&self) -> &[ValType] {
self.inner.results()
}
/// Returns the number of result types of the function type.
pub fn len_results(&self) -> usize {
self.inner.len_results()
}
/// Returns the pair of parameter and result types of the function type.
pub(crate) fn params_results(&self) -> (&[ValType], &[ValType]) {
self.inner.params_results()
}
/// Returns `Ok` if the number and types of items in `params` matches as expected by the [`FuncType`].
///
/// # Errors
///
/// - If the number of items in `params` does not match the number of parameters of the function type.
/// - If any type of an item in `params` does not match the expected type of the function type.
pub(crate) fn match_params<T>(&self, params: &[T]) -> Result<(), FuncError>
where
T: Ty,
{
if self.params().len() != params.len() {
return Err(FuncError::MismatchingParameterLen);
}
if self
.params()
.iter()
.copied()
.ne(params.iter().map(<T as Ty>::ty))
{
return Err(FuncError::MismatchingParameterType);
}
Ok(())
}
/// Returns `Ok` if the number and types of items in `results` matches as expected by the [`FuncType`].
///
/// # Note
///
/// Only checks types if `check_type` is set to `true`.
///
/// # Errors
///
/// - If the number of items in `results` does not match the number of results of the function type.
/// - If any type of an item in `results` does not match the expected type of the function type.
pub(crate) fn match_results<T>(&self, results: &[T], check_type: bool) -> Result<(), FuncError>
where
T: Ty,
{
if self.results().len() != results.len() {
return Err(FuncError::MismatchingResultLen);
}
if check_type
&& self
.results()
.iter()
.copied()
.ne(results.iter().map(<T as Ty>::ty))
{
return Err(FuncError::MismatchingResultType);
}
Ok(())
}
/// Initializes the values in `outputs` to match the types expected by the [`FuncType`].
///
/// # Note
///
/// This is required by an implementation detail of how function result passing is current
/// implemented in the Wasmi execution engine and might change in the future.
///
/// # Panics
///
/// If the number of items in `outputs` does not match the number of results of the [`FuncType`].
pub(crate) fn prepare_outputs(&self, outputs: &mut [Val]) {
assert_eq!(
self.results().len(),
outputs.len(),
"must have the same number of items in outputs as results of the function type"
);
let init_values = self.results().iter().copied().map(Val::default);
outputs
.iter_mut()
.zip(init_values)
.for_each(|(output, init)| *output = init);
}
}
/// Types that have a [`ValType`].
///
/// # Note
///
/// Primarily used to allow `match_params` and `match_results`
/// to be called with both [`Val`] and [`ValType`] parameters.
pub(crate) trait Ty {
fn ty(&self) -> ValType;
}
impl Ty for ValType {
fn ty(&self) -> ValType {
*self
}
}
impl Ty for Val {
fn ty(&self) -> ValType {
self.ty()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn new_empty_works() {
let ft = FuncType::new([], []);
assert!(ft.params().is_empty());
assert!(ft.results().is_empty());
assert_eq!(ft.params(), ft.params_results().0);
assert_eq!(ft.results(), ft.params_results().1);
}
#[test]
fn new_works() {
let types = [
&[ValType::I32][..],
&[ValType::I64][..],
&[ValType::F32][..],
&[ValType::F64][..],
&[ValType::I32, ValType::I32][..],
&[ValType::I32, ValType::I32, ValType::I32][..],
&[ValType::I32, ValType::I32, ValType::I32, ValType::I32][..],
&[
ValType::I32,
ValType::I32,
ValType::I32,
ValType::I32,
ValType::I32,
ValType::I32,
ValType::I32,
ValType::I32,
][..],
&[ValType::I32, ValType::I64, ValType::F32, ValType::F64][..],
];
for params in types {
for results in types {
let ft = FuncType::new(params.iter().copied(), results.iter().copied());
assert_eq!(ft.params(), params);
assert_eq!(ft.results(), results);
assert_eq!(ft.params(), ft.params_results().0);
assert_eq!(ft.results(), ft.params_results().1);
}
}
}
}