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
use crate::{ AccessError, Hash, Integer, Panic, Protocol, StackError, StopReason, ValueError, ValueTypeInfo, }; use thiserror::Error; /// Errors raised by the execution of the virtual machine. #[derive(Error, Debug)] #[error(transparent)] pub struct VmError { kind: Box<VmErrorKind>, } impl<E> From<E> for VmError where VmErrorKind: From<E>, { fn from(err: E) -> Self { Self { kind: Box::new(VmErrorKind::from(err)), } } } impl VmError { /// Access the underlying error kind. pub fn kind(&self) -> &VmErrorKind { &*self.kind } /// Convert into an unwinded vm error. pub fn into_unwinded(self, ip: usize) -> Self { match *self.kind { VmErrorKind::UnwindedVmError { kind, ip } => { Self::from(VmErrorKind::UnwindedVmError { kind, ip }) } kind => Self::from(VmErrorKind::UnwindedVmError { kind: Box::new(kind), ip, }), } } /// Unpack an unwinded error, if it is present. pub fn from_unwinded(self) -> (Self, Option<usize>) { match *self.kind { VmErrorKind::UnwindedVmError { kind, ip } => { let error = Self { kind }; (error, Some(ip)) } kind => { let error = Self::from(kind); (error, None) } } } } impl From<ValueError> for VmError { fn from(error: ValueError) -> Self { match error.unsmuggle_vm_error() { Ok(error) => error, Err(error) => VmError::from(VmErrorKind::ValueError { error }), } } } /// The kind of error encountered. #[derive(Debug, Error)] pub enum VmErrorKind { /// The virtual machine panicked for a specific reason. #[error("panicked `{reason}`")] Panic { /// The reason for the panic. reason: Panic, }, /// The virtual machine stopped for an unexpected reason. #[error("stopped for unexpected reason `{reason}`")] Stopped { /// The reason why the virtual machine stopped. reason: StopReason, }, /// A vm error that was propagated from somewhere else. /// /// In order to represent this, we need to preserve the instruction pointer /// and eventually unit from where the error happened. #[error("{kind} (at {ip})")] UnwindedVmError { /// The actual error. kind: Box<VmErrorKind>, /// The instruction pointer of where the original error happened. ip: usize, }, /// Error raised when external format function results in error. #[error("failed to format argument")] FormatError, /// Error raised when interacting with the stack. #[error("stack error: {error}")] StackError { /// The source error. #[from] error: StackError, }, /// Trying to access an inaccessible reference. #[error("failed to access value: {error}")] AccessError { /// Source error. #[from] error: AccessError, }, /// Error raised when trying to access a value. #[error("value error: {error}")] ValueError { /// Source error. #[source] error: ValueError, }, /// The virtual machine encountered a numerical overflow. #[error("numerical overflow")] Overflow, /// The virtual machine encountered a numerical underflow. #[error("numerical underflow")] Underflow, /// The virtual machine encountered a divide-by-zero. #[error("division by zero")] DivideByZero, /// Failure to lookup function. #[error("missing function with hash `{hash}`")] MissingFunction { /// Hash of function to look up. hash: Hash, }, /// Failure to lookup instance function. #[error("missing instance function for instance `{instance}` with hash `{hash}`")] MissingInstanceFunction { /// The instance type we tried to look up function on. instance: ValueTypeInfo, /// Hash of function to look up. hash: Hash, }, /// Instruction pointer went out-of-bounds. #[error("instruction pointer is out-of-bounds")] IpOutOfBounds, /// Tried to await something on the stack which can't be await:ed. #[error("unsupported target for .await `{actual}`")] UnsupportedAwait { /// The actual target. actual: ValueTypeInfo, }, /// A bad argument that was received to a function. #[error("bad argument `{argument}`")] BadArgument { /// The argument type. argument: ValueTypeInfo, }, /// Unsupported binary operation. #[error("unsupported vm operation `{lhs} {op} {rhs}`")] UnsupportedBinaryOperation { /// Operation. op: &'static str, /// Left-hand side operator. lhs: ValueTypeInfo, /// Right-hand side operator. rhs: ValueTypeInfo, }, /// Unsupported unary operation. #[error("unsupported vm operation `{op}{operand}`")] UnsupportedUnaryOperation { /// Operation. op: &'static str, /// Operand. operand: ValueTypeInfo, }, /// Protocol not implemented on type. #[error("`{actual}` does not implement the `{protocol}` protocol")] MissingProtocol { /// The missing protocol. protocol: Protocol, /// The encountered argument. actual: ValueTypeInfo, }, /// Indicates that a static string is missing for the given slot. #[error("static string slot `{slot}` does not exist")] MissingStaticString { /// Slot which is missing a static string. slot: usize, }, /// Indicates that a static object keys is missing for the given slot. #[error("static object keys slot `{slot}` does not exist")] MissingStaticObjectKeys { /// Slot which is missing a static object keys. slot: usize, }, /// Indicates a failure to convert from one type to another. #[error("failed to convert stack value to `{to}`: {error}")] StackConversionError { /// The source of the error. #[source] error: ValueError, /// The expected type to convert towards. to: &'static str, }, /// Failure to convert from one type to another. #[error("failed to convert argument #{arg} to `{to}`: {error}")] ArgumentConversionError { /// The underlying stack error. #[source] error: ValueError, /// The argument location that was converted. arg: usize, /// The native type we attempt to convert to. to: &'static str, }, /// Wrong number of arguments provided in call. #[error("wrong number of arguments `{actual}`, expected `{expected}`")] ArgumentCountMismatch { /// The actual number of arguments. actual: usize, /// The expected number of arguments. expected: usize, }, /// Failure to convert return value. #[error("failed to convert return value `{ret}`")] ReturnConversionError { /// Error describing the failed conversion. #[source] error: ValueError, /// Type of the return value we attempted to convert. ret: &'static str, }, /// An index set operation that is not supported. #[error("the index set operation `{target}[{index}] = {value}` is not supported")] UnsupportedIndexSet { /// The target type to set. target: ValueTypeInfo, /// The index to set. index: ValueTypeInfo, /// The value to set. value: ValueTypeInfo, }, /// An index get operation that is not supported. #[error("the index get operation `{target}[{index}]` is not supported")] UnsupportedIndexGet { /// The target type to get. target: ValueTypeInfo, /// The index to get. index: ValueTypeInfo, }, /// An tuple index get operation that is not supported. #[error("the tuple index get operation is not supported on `{target}`")] UnsupportedTupleIndexGet { /// The target type we tried to perform the tuple indexing on. target: ValueTypeInfo, }, /// An tuple index set operation that is not supported. #[error("the tuple index set operation is not supported on `{target}`")] UnsupportedTupleIndexSet { /// The target type we tried to perform the tuple indexing on. target: ValueTypeInfo, }, /// An object slot index get operation that is not supported. #[error("field not available on `{target}`")] UnsupportedObjectSlotIndexGet { /// The target type we tried to perform the object indexing on. target: ValueTypeInfo, }, /// An is operation is not supported. #[error("`{value} is {test_type}` is not supported")] UnsupportedIs { /// The argument that is not supported. value: ValueTypeInfo, /// The type that is not supported. test_type: ValueTypeInfo, }, /// Encountered a value that could not be called as a function #[error("`{actual_type}` cannot be called since it's not a function")] UnsupportedCallFn { /// The type that could not be called. actual_type: ValueTypeInfo, }, /// Tried to fetch an index in an object that doesn't exist. #[error("missing index by static string slot `{slot}` in object")] ObjectIndexMissing { /// The static string slot corresponding to the index that is missing. slot: usize, }, /// Tried to access an index that was missing on a type. #[error("missing index `{}` on `{target}`")] MissingIndex { /// Type where field did not exist. target: ValueTypeInfo, /// Index that we tried to access. index: Integer, }, /// Missing a struct field. #[error("missing field `{field}` on `{target}`")] MissingField { /// Type where field did not exist. target: ValueTypeInfo, /// Field that was missing. field: String, }, /// Error raised when we try to unwrap something that is not an option or /// result. #[error("expected result or option with value to unwrap, but got `{actual}`")] UnsupportedUnwrap { /// The actual operand. actual: ValueTypeInfo, }, /// Error raised when we try to unwrap an Option that is not Some. #[error("expected Some value, but got `None`")] UnsupportedUnwrapNone, /// Error raised when we try to unwrap a Result that is not Ok. #[error("expected Ok value, but got `Err({err})`")] UnsupportedUnwrapErr { /// The error variant. err: ValueTypeInfo, }, /// Value is not supported for `is-value` test. #[error("expected result or option as value, but got `{actual}`")] UnsupportedIsValueOperand { /// The actual operand. actual: ValueTypeInfo, }, /// Trying to resume a generator that has completed. #[error("cannot resume generator that has completed")] GeneratorComplete, } impl VmErrorKind { /// Unpack an unwinded error, if it is present. pub fn from_unwinded_ref(&self) -> (&Self, Option<usize>) { match self { VmErrorKind::UnwindedVmError { kind, ip } => (&*kind, Some(*ip)), kind => (kind, None), } } }