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 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
use std::fmt;
use wasmtime_environ::{
EntityType, Global, Memory, ModuleTypes, Table, WasmFuncType, WasmRefType, WasmType,
};
pub(crate) mod matching;
// Type Representations
// Type attributes
/// Indicator of whether a global is mutable or not
#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq)]
pub enum Mutability {
/// The global is constant and its value does not change
Const,
/// The value of the global can change over time
Var,
}
// Value Types
/// A list of all possible value types in WebAssembly.
#[derive(Debug, Clone, Hash, Eq, PartialEq)]
pub enum ValType {
// NB: the ordering here is intended to match the ordering in
// `wasmtime_types::WasmType` to help improve codegen when converting.
/// Signed 32 bit integer.
I32,
/// Signed 64 bit integer.
I64,
/// Floating point 32 bit integer.
F32,
/// Floating point 64 bit integer.
F64,
/// A 128 bit number.
V128,
/// A reference to a Wasm function.
FuncRef,
/// A reference to opaque data in the Wasm instance.
ExternRef,
}
impl fmt::Display for ValType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
ValType::I32 => write!(f, "i32"),
ValType::I64 => write!(f, "i64"),
ValType::F32 => write!(f, "f32"),
ValType::F64 => write!(f, "f64"),
ValType::V128 => write!(f, "v128"),
ValType::ExternRef => write!(f, "externref"),
ValType::FuncRef => write!(f, "funcref"),
}
}
}
impl ValType {
/// Returns true if `ValType` matches any of the numeric types. (e.g. `I32`,
/// `I64`, `F32`, `F64`).
pub fn is_num(&self) -> bool {
match self {
ValType::I32 | ValType::I64 | ValType::F32 | ValType::F64 => true,
_ => false,
}
}
/// Returns true if `ValType` matches either of the reference types.
pub fn is_ref(&self) -> bool {
match self {
ValType::ExternRef | ValType::FuncRef => true,
_ => false,
}
}
pub(crate) fn to_wasm_type(&self) -> WasmType {
match self {
Self::I32 => WasmType::I32,
Self::I64 => WasmType::I64,
Self::F32 => WasmType::F32,
Self::F64 => WasmType::F64,
Self::V128 => WasmType::V128,
Self::FuncRef => WasmType::Ref(WasmRefType::FUNCREF),
Self::ExternRef => WasmType::Ref(WasmRefType::EXTERNREF),
}
}
pub(crate) fn from_wasm_type(ty: &WasmType) -> Self {
match ty {
WasmType::I32 => Self::I32,
WasmType::I64 => Self::I64,
WasmType::F32 => Self::F32,
WasmType::F64 => Self::F64,
WasmType::V128 => Self::V128,
WasmType::Ref(WasmRefType::FUNCREF) => Self::FuncRef,
WasmType::Ref(WasmRefType::EXTERNREF) => Self::ExternRef,
// FIXME: exposing the full function-references (and beyond)
// proposals will require redesigning the embedder API for `ValType`
// and types in Wasmtime. That is a large undertaking which is
// deferred for later. The intention for now is that
// function-references types can't show up in the "public API" of a
// core wasm module but it can use everything internally still.
WasmType::Ref(_) => {
unimplemented!("typed function references are not exposed in the public API yet")
}
}
}
}
// External Types
/// A list of all possible types which can be externally referenced from a
/// WebAssembly module.
///
/// This list can be found in [`ImportType`] or [`ExportType`], so these types
/// can either be imported or exported.
#[derive(Debug, Clone)]
pub enum ExternType {
/// This external type is the type of a WebAssembly function.
Func(FuncType),
/// This external type is the type of a WebAssembly global.
Global(GlobalType),
/// This external type is the type of a WebAssembly table.
Table(TableType),
/// This external type is the type of a WebAssembly memory.
Memory(MemoryType),
}
macro_rules! accessors {
($(($variant:ident($ty:ty) $get:ident $unwrap:ident))*) => ($(
/// Attempt to return the underlying type of this external type,
/// returning `None` if it is a different type.
pub fn $get(&self) -> Option<&$ty> {
if let ExternType::$variant(e) = self {
Some(e)
} else {
None
}
}
/// Returns the underlying descriptor of this [`ExternType`], panicking
/// if it is a different type.
///
/// # Panics
///
/// Panics if `self` is not of the right type.
pub fn $unwrap(&self) -> &$ty {
self.$get().expect(concat!("expected ", stringify!($ty)))
}
)*)
}
impl ExternType {
accessors! {
(Func(FuncType) func unwrap_func)
(Global(GlobalType) global unwrap_global)
(Table(TableType) table unwrap_table)
(Memory(MemoryType) memory unwrap_memory)
}
pub(crate) fn from_wasmtime(types: &ModuleTypes, ty: &EntityType) -> ExternType {
match ty {
EntityType::Function(idx) => FuncType::from_wasm_func_type(types[*idx].clone()).into(),
EntityType::Global(ty) => GlobalType::from_wasmtime_global(ty).into(),
EntityType::Memory(ty) => MemoryType::from_wasmtime_memory(ty).into(),
EntityType::Table(ty) => TableType::from_wasmtime_table(ty).into(),
EntityType::Tag(_) => unimplemented!("wasm tag support"),
}
}
}
impl From<FuncType> for ExternType {
fn from(ty: FuncType) -> ExternType {
ExternType::Func(ty)
}
}
impl From<GlobalType> for ExternType {
fn from(ty: GlobalType) -> ExternType {
ExternType::Global(ty)
}
}
impl From<MemoryType> for ExternType {
fn from(ty: MemoryType) -> ExternType {
ExternType::Memory(ty)
}
}
impl From<TableType> for ExternType {
fn from(ty: TableType) -> ExternType {
ExternType::Table(ty)
}
}
/// A descriptor for a function in a WebAssembly module.
///
/// WebAssembly functions can have 0 or more parameters and results.
#[derive(Debug, Clone, Hash, Eq, PartialEq)]
pub struct FuncType {
sig: WasmFuncType,
}
impl FuncType {
/// Creates a new function descriptor from the given parameters and results.
///
/// The function descriptor returned will represent a function which takes
/// `params` as arguments and returns `results` when it is finished.
pub fn new(
params: impl IntoIterator<Item = ValType>,
results: impl IntoIterator<Item = ValType>,
) -> FuncType {
FuncType {
sig: WasmFuncType::new(
params.into_iter().map(|t| t.to_wasm_type()).collect(),
results.into_iter().map(|t| t.to_wasm_type()).collect(),
),
}
}
/// Returns the list of parameter types for this function.
#[inline]
pub fn params(&self) -> impl ExactSizeIterator<Item = ValType> + '_ {
self.sig.params().iter().map(ValType::from_wasm_type)
}
/// Returns the list of result types for this function.
#[inline]
pub fn results(&self) -> impl ExactSizeIterator<Item = ValType> + '_ {
self.sig.returns().iter().map(ValType::from_wasm_type)
}
pub(crate) fn as_wasm_func_type(&self) -> &WasmFuncType {
&self.sig
}
pub(crate) fn from_wasm_func_type(sig: WasmFuncType) -> FuncType {
Self { sig }
}
}
// Global Types
/// A WebAssembly global descriptor.
///
/// This type describes an instance of a global in a WebAssembly module. Globals
/// are local to an [`Instance`](crate::Instance) and are either immutable or
/// mutable.
#[derive(Debug, Clone, Hash, Eq, PartialEq)]
pub struct GlobalType {
content: ValType,
mutability: Mutability,
}
impl GlobalType {
/// Creates a new global descriptor of the specified `content` type and
/// whether or not it's mutable.
pub fn new(content: ValType, mutability: Mutability) -> GlobalType {
GlobalType {
content,
mutability,
}
}
/// Returns the value type of this global descriptor.
pub fn content(&self) -> &ValType {
&self.content
}
/// Returns whether or not this global is mutable.
pub fn mutability(&self) -> Mutability {
self.mutability
}
/// Returns `None` if the wasmtime global has a type that we can't
/// represent, but that should only very rarely happen and indicate a bug.
pub(crate) fn from_wasmtime_global(global: &Global) -> GlobalType {
let ty = ValType::from_wasm_type(&global.wasm_ty);
let mutability = if global.mutability {
Mutability::Var
} else {
Mutability::Const
};
GlobalType::new(ty, mutability)
}
}
// Table Types
/// A descriptor for a table in a WebAssembly module.
///
/// Tables are contiguous chunks of a specific element, typically a `funcref` or
/// an `externref`. The most common use for tables is a function table through
/// which `call_indirect` can invoke other functions.
#[derive(Debug, Clone, Hash, Eq, PartialEq)]
pub struct TableType {
ty: Table,
}
impl TableType {
/// Creates a new table descriptor which will contain the specified
/// `element` and have the `limits` applied to its length.
///
/// # Panics
///
/// Panics if the `element` type provided is not a reference type.
pub fn new(element: ValType, min: u32, max: Option<u32>) -> TableType {
TableType {
ty: Table {
// FIXME: the `ValType` API should be redesigned and the
// argument to this constructor should be `RefType`.
wasm_ty: match element {
ValType::FuncRef => WasmRefType::FUNCREF,
ValType::ExternRef => WasmRefType::EXTERNREF,
_ => panic!("Attempt to convert non-reference type to a reference type"),
},
minimum: min,
maximum: max,
},
}
}
/// Returns the element value type of this table.
pub fn element(&self) -> ValType {
ValType::from_wasm_type(&WasmType::Ref(self.ty.wasm_ty))
}
/// Returns minimum number of elements this table must have
pub fn minimum(&self) -> u32 {
self.ty.minimum
}
/// Returns the optionally-specified maximum number of elements this table
/// can have.
///
/// If this returns `None` then the table is not limited in size.
pub fn maximum(&self) -> Option<u32> {
self.ty.maximum
}
pub(crate) fn from_wasmtime_table(table: &Table) -> TableType {
TableType { ty: table.clone() }
}
pub(crate) fn wasmtime_table(&self) -> &Table {
&self.ty
}
}
// Memory Types
/// A descriptor for a WebAssembly memory type.
///
/// Memories are described in units of pages (64KB) and represent contiguous
/// chunks of addressable memory.
#[derive(Debug, Clone, Hash, Eq, PartialEq)]
pub struct MemoryType {
ty: Memory,
}
impl MemoryType {
/// Creates a new descriptor for a 32-bit WebAssembly memory given the
/// specified limits of the memory.
///
/// The `minimum` and `maximum` values here are specified in units of
/// WebAssembly pages, which are 64k.
pub fn new(minimum: u32, maximum: Option<u32>) -> MemoryType {
MemoryType {
ty: Memory {
memory64: false,
shared: false,
minimum: minimum.into(),
maximum: maximum.map(|i| i.into()),
},
}
}
/// Creates a new descriptor for a 64-bit WebAssembly memory given the
/// specified limits of the memory.
///
/// The `minimum` and `maximum` values here are specified in units of
/// WebAssembly pages, which are 64k.
///
/// Note that 64-bit memories are part of the memory64 proposal for
/// WebAssembly which is not standardized yet.
pub fn new64(minimum: u64, maximum: Option<u64>) -> MemoryType {
MemoryType {
ty: Memory {
memory64: true,
shared: false,
minimum,
maximum,
},
}
}
/// Creates a new descriptor for shared WebAssembly memory given the
/// specified limits of the memory.
///
/// The `minimum` and `maximum` values here are specified in units of
/// WebAssembly pages, which are 64k.
///
/// Note that shared memories are part of the threads proposal for
/// WebAssembly which is not standardized yet.
pub fn shared(minimum: u32, maximum: u32) -> MemoryType {
MemoryType {
ty: Memory {
memory64: false,
shared: true,
minimum: minimum.into(),
maximum: Some(maximum.into()),
},
}
}
/// Returns whether this is a 64-bit memory or not.
///
/// Note that 64-bit memories are part of the memory64 proposal for
/// WebAssembly which is not standardized yet.
pub fn is_64(&self) -> bool {
self.ty.memory64
}
/// Returns whether this is a shared memory or not.
///
/// Note that shared memories are part of the threads proposal for
/// WebAssembly which is not standardized yet.
pub fn is_shared(&self) -> bool {
self.ty.shared
}
/// Returns minimum number of WebAssembly pages this memory must have.
///
/// Note that the return value, while a `u64`, will always fit into a `u32`
/// for 32-bit memories.
pub fn minimum(&self) -> u64 {
self.ty.minimum
}
/// Returns the optionally-specified maximum number of pages this memory
/// can have.
///
/// If this returns `None` then the memory is not limited in size.
///
/// Note that the return value, while a `u64`, will always fit into a `u32`
/// for 32-bit memories.
pub fn maximum(&self) -> Option<u64> {
self.ty.maximum
}
pub(crate) fn from_wasmtime_memory(memory: &Memory) -> MemoryType {
MemoryType { ty: memory.clone() }
}
pub(crate) fn wasmtime_memory(&self) -> &Memory {
&self.ty
}
}
// Import Types
/// A descriptor for an imported value into a wasm module.
///
/// This type is primarily accessed from the
/// [`Module::imports`](crate::Module::imports) API. Each [`ImportType`]
/// describes an import into the wasm module with the module/name that it's
/// imported from as well as the type of item that's being imported.
#[derive(Clone)]
pub struct ImportType<'module> {
/// The module of the import.
module: &'module str,
/// The field of the import.
name: &'module str,
/// The type of the import.
ty: EntityType,
types: &'module ModuleTypes,
}
impl<'module> ImportType<'module> {
/// Creates a new import descriptor which comes from `module` and `name` and
/// is of type `ty`.
pub(crate) fn new(
module: &'module str,
name: &'module str,
ty: EntityType,
types: &'module ModuleTypes,
) -> ImportType<'module> {
ImportType {
module,
name,
ty,
types,
}
}
/// Returns the module name that this import is expected to come from.
pub fn module(&self) -> &'module str {
self.module
}
/// Returns the field name of the module that this import is expected to
/// come from.
pub fn name(&self) -> &'module str {
self.name
}
/// Returns the expected type of this import.
pub fn ty(&self) -> ExternType {
ExternType::from_wasmtime(self.types, &self.ty)
}
}
impl<'module> fmt::Debug for ImportType<'module> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ImportType")
.field("module", &self.module())
.field("name", &self.name())
.field("ty", &self.ty())
.finish()
}
}
// Export Types
/// A descriptor for an exported WebAssembly value.
///
/// This type is primarily accessed from the
/// [`Module::exports`](crate::Module::exports) accessor and describes what
/// names are exported from a wasm module and the type of the item that is
/// exported.
#[derive(Clone)]
pub struct ExportType<'module> {
/// The name of the export.
name: &'module str,
/// The type of the export.
ty: EntityType,
types: &'module ModuleTypes,
}
impl<'module> ExportType<'module> {
/// Creates a new export which is exported with the given `name` and has the
/// given `ty`.
pub(crate) fn new(
name: &'module str,
ty: EntityType,
types: &'module ModuleTypes,
) -> ExportType<'module> {
ExportType { name, ty, types }
}
/// Returns the name by which this export is known.
pub fn name(&self) -> &'module str {
self.name
}
/// Returns the type of this export.
pub fn ty(&self) -> ExternType {
ExternType::from_wasmtime(self.types, &self.ty)
}
}
impl<'module> fmt::Debug for ExportType<'module> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ExportType")
.field("name", &self.name().to_owned())
.field("ty", &self.ty())
.finish()
}
}