f3b80ece5f
Eventually this should be added to the wasmtime-go binding, addressing https://github.com/bytecodealliance/wasmtime-go/issues/63. Added a snippet to examples/interrupt.c to verify that this works as expected in manual testing. Signed-off-by: Stephan Renatus <stephan.renatus@gmail.com>
107 lines
3.4 KiB
C
107 lines
3.4 KiB
C
/**
|
|
* \file wasmtime/trap.h
|
|
*
|
|
* Wasmtime APIs for interacting with traps and extensions to #wasm_trap_t.
|
|
*/
|
|
|
|
#ifndef WASMTIME_TRAP_H
|
|
#define WASMTIME_TRAP_H
|
|
|
|
#include <wasm.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \brief Code of an instruction trap.
|
|
*
|
|
* See #wasmtime_trap_code_enum for possible values.
|
|
*/
|
|
typedef uint8_t wasmtime_trap_code_t;
|
|
|
|
/**
|
|
* \brief Trap codes for instruction traps.
|
|
*/
|
|
enum wasmtime_trap_code_enum {
|
|
/// The current stack space was exhausted.
|
|
WASMTIME_TRAP_CODE_STACK_OVERFLOW,
|
|
/// An out-of-bounds memory access.
|
|
WASMTIME_TRAP_CODE_MEMORY_OUT_OF_BOUNDS,
|
|
/// A wasm atomic operation was presented with a not-naturally-aligned linear-memory address.
|
|
WASMTIME_TRAP_CODE_HEAP_MISALIGNED,
|
|
/// An out-of-bounds access to a table.
|
|
WASMTIME_TRAP_CODE_TABLE_OUT_OF_BOUNDS,
|
|
/// Indirect call to a null table entry.
|
|
WASMTIME_TRAP_CODE_INDIRECT_CALL_TO_NULL,
|
|
/// Signature mismatch on indirect call.
|
|
WASMTIME_TRAP_CODE_BAD_SIGNATURE,
|
|
/// An integer arithmetic operation caused an overflow.
|
|
WASMTIME_TRAP_CODE_INTEGER_OVERFLOW,
|
|
/// An integer division by zero.
|
|
WASMTIME_TRAP_CODE_INTEGER_DIVISION_BY_ZERO,
|
|
/// Failed float-to-int conversion.
|
|
WASMTIME_TRAP_CODE_BAD_CONVERSION_TO_INTEGER,
|
|
/// Code that was supposed to have been unreachable was reached.
|
|
WASMTIME_TRAP_CODE_UNREACHABLE_CODE_REACHED,
|
|
/// Execution has potentially run too long and may be interrupted.
|
|
WASMTIME_TRAP_CODE_INTERRUPT,
|
|
};
|
|
|
|
/**
|
|
* \brief Creates a new trap.
|
|
*
|
|
* \param msg the message to associate with this trap
|
|
* \param msg_len the byte length of `msg`
|
|
*
|
|
* The #wasm_trap_t returned is owned by the caller.
|
|
*/
|
|
WASM_API_EXTERN wasm_trap_t *wasmtime_trap_new(const char *msg, size_t msg_len);
|
|
|
|
/**
|
|
* \brief Attempts to extract the trap code from this trap.
|
|
*
|
|
* Returns `true` if the trap is an instruction trap triggered while
|
|
* executing Wasm. If `true` is returned then the trap code is returned
|
|
* through the `code` pointer. If `false` is returned then this is not
|
|
* an instruction trap -- traps can also be created using wasm_trap_new,
|
|
* or occur with WASI modules exiting with a certain exit code.
|
|
*/
|
|
WASM_API_EXTERN bool wasmtime_trap_code(const wasm_trap_t*, wasmtime_trap_code_t *code);
|
|
|
|
/**
|
|
* \brief Attempts to extract a WASI-specific exit status from this trap.
|
|
*
|
|
* Returns `true` if the trap is a WASI "exit" trap and has a return status. If
|
|
* `true` is returned then the exit status is returned through the `status`
|
|
* pointer. If `false` is returned then this is not a wasi exit trap.
|
|
*/
|
|
WASM_API_EXTERN bool wasmtime_trap_exit_status(const wasm_trap_t*, int *status);
|
|
|
|
/**
|
|
* \brief Returns a human-readable name for this frame's function.
|
|
*
|
|
* This function will attempt to load a human-readable name for function this
|
|
* frame points to. This function may return `NULL`.
|
|
*
|
|
* The lifetime of the returned name is the same as the #wasm_frame_t itself.
|
|
*/
|
|
WASM_API_EXTERN const wasm_name_t *wasmtime_frame_func_name(const wasm_frame_t*);
|
|
|
|
/**
|
|
* \brief Returns a human-readable name for this frame's module.
|
|
*
|
|
* This function will attempt to load a human-readable name for module this
|
|
* frame points to. This function may return `NULL`.
|
|
*
|
|
* The lifetime of the returned name is the same as the #wasm_frame_t itself.
|
|
*/
|
|
WASM_API_EXTERN const wasm_name_t *wasmtime_frame_module_name(const wasm_frame_t*);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // WASMTIME_TRAP_H
|