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
#[cfg(feature = "js")]
use crate::js::trap::Trap;
#[cfg(feature = "jsc")]
use crate::jsc::trap::Trap;
use std::fmt;
use std::sync::Arc;
use thiserror::Error;
use wasmer_types::{FrameInfo, TrapCode};
#[cfg(feature = "sys")]
use wasmer_vm::Trap;
use wasmer_types::ImportError;
/// The WebAssembly.LinkError object indicates an error during
/// module instantiation (besides traps from the start function).
///
/// This is based on the [link error][link-error] API.
///
/// [link-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/LinkError
#[derive(Debug, Clone)]
#[cfg_attr(feature = "std", derive(Error))]
#[cfg_attr(feature = "std", error("Link error: {0}"))]
pub enum LinkError {
/// An error occurred when checking the import types.
#[cfg_attr(feature = "std", error("Error while importing {0:?}.{1:?}: {2}"))]
Import(String, String, ImportError),
/// A trap ocurred during linking.
#[cfg_attr(feature = "std", error("RuntimeError occurred during linking: {0}"))]
Trap(#[source] RuntimeError),
/// Insufficient resources available for linking.
#[cfg_attr(feature = "std", error("Insufficient resources: {0}"))]
Resource(String),
}
/// An error while instantiating a module.
///
/// This is not a common WebAssembly error, however
/// we need to differentiate from a `LinkError` (an error
/// that happens while linking, on instantiation), a
/// Trap that occurs when calling the WebAssembly module
/// start function, and an error when initializing the user's
/// host environments.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "std", derive(Error))]
pub enum InstantiationError {
/// A linking ocurred during instantiation.
#[cfg_attr(feature = "std", error(transparent))]
Link(LinkError),
/// A runtime error occured while invoking the start function
#[cfg_attr(feature = "std", error(transparent))]
Start(RuntimeError),
/// The module was compiled with a CPU feature that is not available on
/// the current host.
#[cfg_attr(feature = "std", error("missing required CPU features: {0:?}"))]
CpuFeature(String),
/// Import from a different [`Store`][super::Store].
/// This error occurs when an import from a different store is used.
#[cfg_attr(feature = "std", error("cannot mix imports from different stores"))]
DifferentStores,
/// Import from a different Store.
/// This error occurs when an import from a different store is used.
#[cfg_attr(feature = "std", error("incorrect OS or architecture"))]
DifferentArchOS,
}
/// A struct representing an aborted instruction execution, with a message
/// indicating the cause.
#[derive(Clone)]
pub struct RuntimeError {
pub(crate) inner: Arc<RuntimeErrorInner>,
}
#[derive(Debug)]
struct RuntimeStringError {
details: String,
}
impl RuntimeStringError {
fn new(msg: String) -> Self {
Self { details: msg }
}
}
impl fmt::Display for RuntimeStringError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", self.details)
}
}
impl std::error::Error for RuntimeStringError {
fn description(&self) -> &str {
&self.details
}
}
pub(crate) struct RuntimeErrorInner {
/// The source error
pub(crate) source: Trap,
/// The trap code (if any)
trap_code: Option<TrapCode>,
/// The reconstructed Wasm trace (from the native trace and the `GlobalFrameInfo`).
wasm_trace: Vec<FrameInfo>,
}
impl RuntimeError {
/// Creates a new generic `RuntimeError` with the given `message`.
///
/// # Example
/// ```
/// let trap = wasmer::RuntimeError::new("unexpected error");
/// assert_eq!("unexpected error", trap.message());
/// ```
pub fn new<I: Into<String>>(message: I) -> Self {
let msg = message.into();
let source = RuntimeStringError::new(msg);
Self::user(Box::new(source))
}
/// Creates `RuntimeError` from an error and a WasmTrace
///
/// # Example
/// ```ignore
/// let wasm_trace = vec![wasmer_types::FrameInfo::new(
/// "my_module".to_string(),
/// 0,
/// Some("my_function".to_string()),
/// 0.into(),
/// 2.into()
/// )];
/// let trap = wasmer::RuntimeError::new_from_source(my_error, wasm_trace, None);
/// assert_eq!("unexpected error", trap.message());
/// ```
pub fn new_from_source(
source: Trap,
wasm_trace: Vec<FrameInfo>,
trap_code: Option<TrapCode>,
) -> Self {
Self {
inner: Arc::new(RuntimeErrorInner {
source,
wasm_trace,
trap_code,
}),
}
}
/// Creates a custom user Error.
///
/// This error object can be passed through Wasm frames and later retrieved
/// using the `downcast` method.
pub fn user(error: Box<dyn std::error::Error + Send + Sync>) -> Self {
match error.downcast::<Self>() {
Ok(err) => *err,
Err(error) => error.into(),
}
}
/// Returns a reference the `message` stored in `Trap`.
pub fn message(&self) -> String {
if let Some(trap_code) = self.inner.trap_code {
trap_code.message().to_string()
} else {
self.inner.source.to_string()
}
}
/// Returns a list of function frames in WebAssembly code that led to this
/// trap happening.
pub fn trace(&self) -> &[FrameInfo] {
&self.inner.wasm_trace
}
/// Returns trap code, if it's a Trap
pub fn to_trap(self) -> Option<TrapCode> {
self.inner.trap_code
}
// /// Returns trap code, if it's a Trap
// pub fn to_source(self) -> &'static Trap {
// &self.inner.as_ref().source
// }
/// Attempts to downcast the `RuntimeError` to a concrete type.
pub fn downcast<T: std::error::Error + 'static>(self) -> Result<T, Self> {
match Arc::try_unwrap(self.inner) {
Ok(inner) if inner.source.is::<T>() => Ok(inner.source.downcast::<T>().unwrap()),
Ok(inner) => Err(Self {
inner: Arc::new(inner),
}),
Err(inner) => Err(Self { inner }),
}
}
/// Attempts to downcast the `RuntimeError` to a concrete type.
pub fn downcast_ref<T: std::error::Error + 'static>(&self) -> Option<&T> {
self.inner.as_ref().source.downcast_ref::<T>()
}
/// Returns true if the `RuntimeError` is the same as T
pub fn is<T: std::error::Error + 'static>(&self) -> bool {
self.inner.source.is::<T>()
}
}
impl fmt::Debug for RuntimeError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("RuntimeError")
.field("source", &self.inner.source)
.field("wasm_trace", &self.inner.wasm_trace)
.finish()
}
}
impl fmt::Display for RuntimeError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "RuntimeError: {}", self.message())?;
let trace = self.trace();
if trace.is_empty() {
return Ok(());
}
for frame in self.trace().iter() {
let name = frame.module_name();
let func_index = frame.func_index();
writeln!(f)?;
write!(f, " at ")?;
match frame.function_name() {
Some(name) => match rustc_demangle::try_demangle(name) {
Ok(name) => write!(f, "{}", name)?,
Err(_) => write!(f, "{}", name)?,
},
None => write!(f, "<unnamed>")?,
}
write!(
f,
" ({}[{}]:0x{:x})",
name,
func_index,
frame.module_offset()
)?;
}
Ok(())
}
}
impl std::error::Error for RuntimeError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
self.inner.source.source()
}
}
impl From<Box<dyn std::error::Error + Send + Sync>> for RuntimeError {
fn from(error: Box<dyn std::error::Error + Send + Sync>) -> Self {
match error.downcast::<Self>() {
// The error is already a RuntimeError, we return it directly
Ok(runtime_error) => *runtime_error,
Err(error) => Trap::user(error).into(),
}
}
}
/// Error that can occur during atomic operations. (notify/wait)
// Non-exhaustive to allow for future variants without breaking changes!
#[derive(PartialEq, Eq, Debug, Error)]
#[non_exhaustive]
pub enum AtomicsError {
/// Atomic operations are not supported by this memory.
Unimplemented,
/// To many waiter for address.
TooManyWaiters,
/// Atomic operations are disabled.
AtomicsDisabled,
}
impl std::fmt::Display for AtomicsError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Unimplemented => write!(f, "Atomic operations are not supported"),
Self::TooManyWaiters => write!(f, "Too many waiters for address"),
Self::AtomicsDisabled => write!(f, "Atomic operations are disabled"),
}
}
}