A lightweight WebAssembly runtime that is fast, secure, and standards-compliant
Tiny OOM docs tweaks and additions (#13420)
Nick Fitzgeralddb3f11a97dea
diff --git a/crates/core/src/error/oom.rs b/crates/core/src/error/oom.rsindex ae02c5caa1..138de94435 100644--- a/crates/core/src/error/oom.rs+++ b/crates/core/src/error/oom.rs@@ -13,7 +13,7 @@ use core::{fmt, mem, ptr::NonNull};/// # Out-of-Memory Handling in Wasmtime////// Wasmtime performs out-of-memory (OOM) error handling on a **best-effort-/// basis**. OOM handling does not have [tier 1+/// basis**. OOM handling does _not_ have [tier 1/// support](https://docs.wasmtime.dev/stability-tiers.html) at this time and,/// therefore, while failure to handle OOM at some allocation site may be/// considered a bug, and might be a potential denial-of-service vector, it@@ -42,26 +42,28 @@ use core::{fmt, mem, ptr::NonNull};/// should generally document this fact by listing `OutOfMemory` as one of the/// potential errors returned.///-/// | **Where** | **Handles OOM?** |-/// |-------------------------------------------------|---------------------------------|-/// | **Compiler** | **No** |-/// |  `wasmtime::Module::new` | No |-/// |  `wasmtime::Component::new` | No |-/// |  `wasmtime::CodeBuilder` | No |-/// |  Other compilation APIs... | No |-/// | **Runtime** | **Yes** |-/// |  `wasmtime::Store` | Yes |-/// |  `wasmtime::Linker` | Yes |-/// |  `wasmtime::Module::deserialize` | Yes |-/// |  `wasmtime::Instance` | Yes |-/// |  `wasmtime::Func::call` | Yes |-/// |  Component Model concurrency/async APIs | Not yet |-/// |  Other instantiation and execution APIs... | Yes |-/// | **WASI Implementations and Host APIs** | **Depends** |-/// |  `wasmtime_wasi` | No |-/// |  `wasmtime_wasi_http` | No |-/// |  `wasmtime_wasi_*` | No |-/// |  Your embedding's APIs | If *you* implement OOM handling |+/// | **Where** | **Handles OOM?** |+/// |---------------------------------------------------|---------------------------------|+/// | **Compiler** | **No** |+/// |  `wasmtime::Module::new` | No |+/// |  `wasmtime::Component::new` | No |+/// |  `wasmtime::CodeBuilder` | No |+/// |  Other compilation APIs... | No |+/// | **Runtime** | **Yes** |+/// |  `wasmtime::Store` | Yes |+/// |  `wasmtime::Linker` | Yes |+/// |  `wasmtime::Module::deserialize` | Yes |+/// |  `wasmtime::Instance` | Yes |+/// |  `wasmtime::Func::call` | Yes |+/// |  Wasm execution | Yes |+/// |  Garbage collector and related APIs | Not yet |+/// |  Component Model concurrency/async APIs | Not yet |+/// |  Other instantiation and execution APIs... | Yes |+/// | **WASI Implementations and Host APIs** | **Depends** |+/// |  `wasmtime_wasi` | No |+/// |  `wasmtime_wasi_http` | No |+/// |  `wasmtime_wasi_*` | No |+/// |  Your embedding's APIs / WASI implementation | If *you* implement OOM handling |////// If you encounter an unhandled OOM inside Wasmtime, and it is within a/// portion of code where it should be handled, then please [file an