wasmtime/config.rs
1use crate::Engine;
2use crate::prelude::*;
3use alloc::sync::Arc;
4use bitflags::Flags;
5use core::fmt;
6use core::num::{NonZeroU32, NonZeroUsize};
7use core::str::FromStr;
8#[cfg(any(feature = "cranelift", feature = "winch"))]
9use std::path::Path;
10pub use wasmparser::WasmFeatures;
11#[cfg(any(feature = "cranelift", feature = "winch"))]
12use wasmtime_environ::FlagValue;
13use wasmtime_environ::{ConfigTunables, OperatorCost, OperatorCostStrategy, TripleExt, Tunables};
14
15#[cfg(feature = "runtime")]
16use crate::memory::MemoryCreator;
17#[cfg(feature = "runtime")]
18use crate::profiling_agent::{self, ProfilingAgent};
19#[cfg(feature = "runtime")]
20use crate::runtime::vm::{
21 GcRuntime, InstanceAllocator, OnDemandInstanceAllocator, RuntimeMemoryCreator,
22};
23#[cfg(feature = "runtime")]
24use crate::trampoline::MemoryCreatorProxy;
25
26#[cfg(feature = "async")]
27use crate::stack::{StackCreator, StackCreatorProxy};
28#[cfg(feature = "async")]
29use wasmtime_fiber::RuntimeFiberStackCreator;
30
31#[cfg(feature = "runtime")]
32pub use crate::runtime::code_memory::CustomCodeMemory;
33#[cfg(feature = "cache")]
34pub use wasmtime_cache::{Cache, CacheConfig};
35#[cfg(all(feature = "incremental-cache", feature = "cranelift"))]
36pub use wasmtime_environ::CacheStore;
37pub use wasmtime_environ::Inlining;
38
39pub(crate) const DEFAULT_WASM_BACKTRACE_MAX_FRAMES: NonZeroUsize = NonZeroUsize::new(20).unwrap();
40
41/// Represents the module instance allocation strategy to use.
42#[derive(Clone)]
43#[non_exhaustive]
44pub enum InstanceAllocationStrategy {
45 /// The on-demand instance allocation strategy.
46 ///
47 /// Resources related to a module instance are allocated at instantiation time and
48 /// immediately deallocated when the `Store` referencing the instance is dropped.
49 ///
50 /// This is the default allocation strategy for Wasmtime.
51 OnDemand,
52 /// The pooling instance allocation strategy.
53 ///
54 /// A pool of resources is created in advance and module instantiation reuses resources
55 /// from the pool. Resources are returned to the pool when the `Store` referencing the instance
56 /// is dropped.
57 ///
58 /// When GC is enabled, the pooling allocator requires that the GC heap
59 /// configuration matches the linear memory configuration (i.e.,
60 /// `gc_heap_reservation` must equal `memory_reservation`, etc.). By
61 /// default, if no `gc_heap_*` tunables are explicitly configured, they
62 /// automatically inherit the `memory_*` values.
63 #[cfg(feature = "pooling-allocator")]
64 Pooling(PoolingAllocationConfig),
65}
66
67impl InstanceAllocationStrategy {
68 /// The default pooling instance allocation strategy.
69 #[cfg(feature = "pooling-allocator")]
70 pub fn pooling() -> Self {
71 Self::Pooling(Default::default())
72 }
73}
74
75impl Default for InstanceAllocationStrategy {
76 fn default() -> Self {
77 Self::OnDemand
78 }
79}
80
81#[cfg(feature = "pooling-allocator")]
82impl From<PoolingAllocationConfig> for InstanceAllocationStrategy {
83 fn from(cfg: PoolingAllocationConfig) -> InstanceAllocationStrategy {
84 InstanceAllocationStrategy::Pooling(cfg)
85 }
86}
87
88#[derive(Clone)]
89/// Configure the strategy used for versioning in serializing and deserializing [`crate::Module`].
90pub enum ModuleVersionStrategy {
91 /// Use the wasmtime crate's Cargo package version.
92 WasmtimeVersion,
93 /// Use a custom version string. Must be at most 255 bytes.
94 Custom(String),
95 /// Emit no version string in serialization, and accept all version strings in deserialization.
96 None,
97}
98
99impl Default for ModuleVersionStrategy {
100 fn default() -> Self {
101 ModuleVersionStrategy::WasmtimeVersion
102 }
103}
104
105impl core::hash::Hash for ModuleVersionStrategy {
106 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
107 match self {
108 Self::WasmtimeVersion => env!("CARGO_PKG_VERSION").hash(hasher),
109 Self::Custom(s) => s.hash(hasher),
110 Self::None => {}
111 };
112 }
113}
114
115impl ModuleVersionStrategy {
116 /// Get the string-encoding version of the module.
117 pub fn as_str(&self) -> &str {
118 match &self {
119 Self::WasmtimeVersion => env!("CARGO_PKG_VERSION_MAJOR"),
120 Self::Custom(c) => c,
121 Self::None => "",
122 }
123 }
124}
125
126/// Configuration for record/replay
127#[derive(Clone)]
128#[non_exhaustive]
129pub enum RRConfig {
130 #[cfg(feature = "rr")]
131 /// Recording on store is enabled
132 Recording,
133 #[cfg(feature = "rr")]
134 /// Replaying on store is enabled
135 Replaying,
136 /// No record/replay is enabled
137 None,
138}
139
140/// Global configuration options used to create an [`Engine`]
141/// and customize its behavior.
142///
143/// This structure exposed a builder-like interface and is primarily consumed by
144/// [`Engine::new()`].
145///
146/// The validation of `Config` is deferred until the engine is being built, thus
147/// a problematic config may cause [`Engine::new`] to fail.
148///
149/// # Defaults
150///
151/// The `Default` trait implementation and the return value from
152/// [`Config::new()`] are the same and represent the default set of
153/// configuration for an engine. The exact set of defaults will differ based on
154/// properties such as enabled Cargo features at compile time and the configured
155/// target (see [`Config::target`]). Configuration options document their
156/// default values and what the conditional value of the default is where
157/// applicable.
158#[derive(Clone)]
159pub struct Config {
160 #[cfg(any(feature = "cranelift", feature = "winch"))]
161 compiler_config: Option<CompilerConfig>,
162 target: Option<target_lexicon::Triple>,
163 #[cfg(feature = "gc")]
164 collector: Collector,
165 profiling_strategy: ProfilingStrategy,
166 tunables: ConfigTunables,
167
168 #[cfg(feature = "cache")]
169 pub(crate) cache: Option<Cache>,
170 #[cfg(feature = "runtime")]
171 pub(crate) mem_creator: Option<Arc<dyn RuntimeMemoryCreator>>,
172 #[cfg(feature = "runtime")]
173 pub(crate) custom_code_memory: Option<Arc<dyn CustomCodeMemory>>,
174 pub(crate) allocation_strategy: InstanceAllocationStrategy,
175 pub(crate) max_wasm_stack: usize,
176 /// Explicitly enabled features via `Config::wasm_*` methods. This is a
177 /// signal that the embedder specifically wants something turned on
178 /// regardless of the defaults that Wasmtime might otherwise have enabled.
179 ///
180 /// Note that this, and `disabled_features` below, start as the empty set of
181 /// features to only track explicit user requests.
182 pub(crate) enabled_features: WasmFeatures,
183 /// Same as `enabled_features`, but for those that are explicitly disabled.
184 pub(crate) disabled_features: WasmFeatures,
185 pub(crate) wasm_backtrace_details_env_used: bool,
186 pub(crate) wasm_backtrace_max_frames: Option<NonZeroUsize>,
187 pub(crate) native_unwind_info: Option<bool>,
188 pub(crate) async_stack_size: usize,
189 pub(crate) async_stack_zeroing: bool,
190 #[cfg(feature = "async")]
191 pub(crate) stack_creator: Option<Arc<dyn RuntimeFiberStackCreator>>,
192 pub(crate) module_version: ModuleVersionStrategy,
193 pub(crate) parallel_compilation: bool,
194 pub(crate) memory_guaranteed_dense_image_size: u64,
195 pub(crate) force_memory_init_memfd: bool,
196 pub(crate) wmemcheck: bool,
197 #[cfg(feature = "coredump")]
198 pub(crate) coredump_on_trap: bool,
199 pub(crate) macos_use_mach_ports: bool,
200 pub(crate) detect_host_feature: Option<fn(&str) -> Option<bool>>,
201 pub(crate) x86_float_abi_ok: Option<bool>,
202 pub(crate) shared_memory: bool,
203 pub(crate) rr_config: RRConfig,
204}
205
206/// User-provided configuration for the compiler.
207#[cfg(any(feature = "cranelift", feature = "winch"))]
208#[derive(Debug, Clone)]
209struct CompilerConfig {
210 strategy: Option<Strategy>,
211 settings: crate::hash_map::HashMap<String, (String, UserSpecified)>,
212 flags: crate::hash_map::HashMap<String, UserSpecified>,
213 #[cfg(all(feature = "incremental-cache", feature = "cranelift"))]
214 cache_store: Option<Arc<dyn CacheStore>>,
215 clif_dir: Option<std::path::PathBuf>,
216 wmemcheck: bool,
217}
218
219#[cfg(any(feature = "cranelift", feature = "winch"))]
220#[derive(Debug, Clone)]
221enum UserSpecified {
222 Yes,
223 No,
224}
225
226#[cfg(any(feature = "cranelift", feature = "winch"))]
227impl CompilerConfig {
228 fn new() -> Self {
229 Self {
230 strategy: Strategy::Auto.not_auto(),
231 settings: Default::default(),
232 flags: Default::default(),
233 #[cfg(all(feature = "incremental-cache", feature = "cranelift"))]
234 cache_store: None,
235 clif_dir: None,
236 wmemcheck: false,
237 }
238 }
239
240 /// Ensures that the key is not set or equals to the given value.
241 /// If the key is not set, it will be set to the given value.
242 ///
243 /// # Returns
244 ///
245 /// Returns true if successfully set or already had the given setting
246 /// value, or false if the setting was explicitly set to something
247 /// else previously.
248 fn ensure_setting_unset_or_given(&mut self, k: &str, v: &str) -> bool {
249 if let Some((value, _)) = self.settings.get(k) {
250 if value != v {
251 return false;
252 }
253 } else {
254 self.settings
255 .insert(k.to_string(), (v.to_string(), UserSpecified::No));
256 }
257 true
258 }
259}
260
261#[cfg(any(feature = "cranelift", feature = "winch"))]
262impl Default for CompilerConfig {
263 fn default() -> Self {
264 Self::new()
265 }
266}
267
268impl Config {
269 /// Creates a new configuration object with the default configuration
270 /// specified.
271 pub fn new() -> Self {
272 let mut ret = Self {
273 tunables: ConfigTunables::default(),
274 #[cfg(any(feature = "cranelift", feature = "winch"))]
275 compiler_config: Some(CompilerConfig::default()),
276 target: None,
277 #[cfg(feature = "gc")]
278 collector: Collector::default(),
279 #[cfg(feature = "cache")]
280 cache: None,
281 profiling_strategy: ProfilingStrategy::None,
282 #[cfg(feature = "runtime")]
283 mem_creator: None,
284 #[cfg(feature = "runtime")]
285 custom_code_memory: None,
286 allocation_strategy: InstanceAllocationStrategy::OnDemand,
287 // 512k of stack -- note that this is chosen currently to not be too
288 // big, not be too small, and be a good default for most platforms.
289 // One platform of particular note is Windows where the stack size
290 // of the main thread seems to, by default, be smaller than that of
291 // Linux and macOS. This 512k value at least lets our current test
292 // suite pass on the main thread of Windows (using `--test-threads
293 // 1` forces this), or at least it passed when this change was
294 // committed.
295 max_wasm_stack: 512 * 1024,
296 wasm_backtrace_details_env_used: false,
297 wasm_backtrace_max_frames: Some(DEFAULT_WASM_BACKTRACE_MAX_FRAMES),
298 native_unwind_info: None,
299 enabled_features: WasmFeatures::empty(),
300 disabled_features: WasmFeatures::empty(),
301 async_stack_size: 2 << 20,
302 async_stack_zeroing: false,
303 #[cfg(feature = "async")]
304 stack_creator: None,
305 module_version: ModuleVersionStrategy::default(),
306 parallel_compilation: !cfg!(miri),
307 memory_guaranteed_dense_image_size: 16 << 20,
308 force_memory_init_memfd: false,
309 wmemcheck: false,
310 #[cfg(feature = "coredump")]
311 coredump_on_trap: false,
312 macos_use_mach_ports: !cfg!(miri),
313 #[cfg(feature = "std")]
314 detect_host_feature: Some(detect_host_feature),
315 #[cfg(not(feature = "std"))]
316 detect_host_feature: None,
317 x86_float_abi_ok: None,
318 shared_memory: false,
319 rr_config: RRConfig::None,
320 };
321 ret.wasm_backtrace_details(WasmBacktraceDetails::Environment);
322 ret
323 }
324
325 #[cfg(any(feature = "cranelift", feature = "winch"))]
326 pub(crate) fn has_compiler(&self) -> bool {
327 self.compiler_config.is_some()
328 }
329
330 #[track_caller]
331 #[cfg(any(feature = "cranelift", feature = "winch"))]
332 fn compiler_config_mut(&mut self) -> &mut CompilerConfig {
333 self.compiler_config.as_mut().expect(
334 "cannot configure compiler settings for `Config`s \
335 created by `Config::without_compiler`",
336 )
337 }
338
339 /// Configure whether Wasm compilation is enabled.
340 ///
341 /// Disabling Wasm compilation will allow you to load and run
342 /// [pre-compiled][Engine::precompile_module] Wasm programs, but not
343 /// to compile and run new Wasm programs that have not already been
344 /// pre-compiled.
345 ///
346 /// Many compilation-related configuration methods will panic if compilation
347 /// has been disabled.
348 ///
349 /// Note that there are two ways to disable Wasm compilation:
350 ///
351 /// 1. Statically, by disabling the `"cranelift"` and `"winch"` cargo
352 /// features when building Wasmtime. These builds of Wasmtime will have
353 /// smaller code size, since they do not include any of the code to
354 /// compile Wasm.
355 ///
356 /// 2. Dynamically, by passing `false` to this method at run-time when
357 /// configuring Wasmtime. The Wasmtime binary will still include the code
358 /// for compiling Wasm, it just won't be executed, so code size is larger
359 /// than with the first approach.
360 ///
361 /// The static approach is better in most cases, however dynamically calling
362 /// `enable_compiler(false)` is useful whenever you create multiple
363 /// [`Engine`]s in the same process, some of which must be able to compile
364 /// Wasm and some of which should never do so. Tests are a common example of
365 /// such a situation, especially when there are multiple Rust binaries in
366 /// the same cargo workspace, and cargo's feature resolution enables the
367 /// `"cranelift"` or `"winch"` features across the whole workspace.
368 #[cfg(any(feature = "cranelift", feature = "winch"))]
369 pub fn enable_compiler(&mut self, enable: bool) -> &mut Self {
370 match (enable, &self.compiler_config) {
371 (true, Some(_)) | (false, None) => {}
372 (true, None) => {
373 self.compiler_config = Some(CompilerConfig::default());
374 }
375 (false, Some(_)) => {
376 self.compiler_config = None;
377 }
378 }
379 self
380 }
381
382 /// Configures the target platform of this [`Config`].
383 ///
384 /// This method is used to configure the output of compilation in an
385 /// [`Engine`]. This can be used, for example, to
386 /// cross-compile from one platform to another. By default, the host target
387 /// triple is used meaning compiled code is suitable to run on the host.
388 ///
389 /// Note that the [`Module`](crate::Module) type can only be created if the
390 /// target configured here matches the host. Otherwise if a cross-compile is
391 /// being performed where the host doesn't match the target then
392 /// [`Engine::precompile_module`] must be used instead.
393 ///
394 /// Target-specific flags (such as CPU features) will not be inferred by
395 /// default for the target when one is provided here. This means that this
396 /// can also be used, for example, with the host architecture to disable all
397 /// host-inferred feature flags. Configuring target-specific flags can be
398 /// done with [`Config::cranelift_flag_set`] and
399 /// [`Config::cranelift_flag_enable`].
400 ///
401 /// # Errors
402 ///
403 /// This method will error if the given target triple is not supported.
404 pub fn target(&mut self, target: &str) -> Result<&mut Self> {
405 self.target =
406 Some(target_lexicon::Triple::from_str(target).map_err(|e| crate::format_err!(e))?);
407
408 Ok(self)
409 }
410
411 /// Enables the incremental compilation cache in Cranelift, using the provided `CacheStore`
412 /// backend for storage.
413 ///
414 /// # Panics
415 ///
416 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
417 #[cfg(all(feature = "incremental-cache", feature = "cranelift"))]
418 pub fn enable_incremental_compilation(
419 &mut self,
420 cache_store: Arc<dyn CacheStore>,
421 ) -> Result<&mut Self> {
422 self.compiler_config_mut().cache_store = Some(cache_store);
423 Ok(self)
424 }
425
426 #[doc(hidden)]
427 #[deprecated(note = "no longer has any effect")]
428 #[cfg(feature = "async")]
429 pub fn async_support(&mut self, _enable: bool) -> &mut Self {
430 self
431 }
432
433 /// Configures whether DWARF debug information will be emitted
434 /// during compilation for a native debugger on the Wasmtime
435 /// process to consume.
436 ///
437 /// Note that the `debug-builtins` compile-time Cargo feature must also be
438 /// enabled for native debuggers such as GDB or LLDB to be able to debug
439 /// guest WebAssembly programs.
440 ///
441 /// By default this option is `false`.
442 /// **Note** Enabling this option is not compatible with the Winch compiler.
443 pub fn debug_info(&mut self, enable: bool) -> &mut Self {
444 self.tunables.debug_native = Some(enable);
445 self
446 }
447
448 /// Whether or not symbols are located in generated compiled module
449 /// artifacts.
450 ///
451 /// Wasmtime's currently representation of compiled artifacts is an ELF
452 /// file. ELF files have symbol tables and such and this option enables
453 /// whether symbols are emitted for wasm functions. This utility can be
454 /// useful when profiling wasm modules (many profilers work with
455 /// ELF-in-memory by default without futher configuration), introspection of
456 /// a `*.cwasm` (e.g. the symbol table is what `wasmtime objdump` reads), or
457 /// just general binary analysis of the result ELF file. Large wasm modules
458 /// can have large symbol tables, however, and the symbols serve no purpose
459 /// at runtime meaning that they are pure overhead for minimal module as
460 /// well. This option can be used to disable these symbols which will reduce
461 /// the debuggability of modules but will also reduce their size.
462 ///
463 /// Note that the ELF file representation is considered an implementation
464 /// detail of Wasmtime and embedders should not rely on this format.
465 /// Wasmtime may change the format of artifacts in the future.
466 ///
467 /// This option is `true` by default.
468 ///
469 /// This option is required if [`Config::debug_info`] is enabled.
470 pub fn debug_symbols(&mut self, enable: bool) -> &mut Self {
471 self.tunables.debug_symbols = Some(enable);
472 self
473 }
474
475 /// Configures whether compiled guest code will be instrumented to
476 /// provide debugging at the Wasm VM level.
477 ///
478 /// This is required in order to enable a guest-level debugging
479 /// API that can precisely examine Wasm VM state and (eventually,
480 /// once it is complete) set breakpoints and watchpoints and step
481 /// through code.
482 ///
483 /// Without this enabled, debugging can only be done via a native
484 /// debugger operating on the compiled guest code (see
485 /// [`Config::debug_info`] and is "best-effort": we may be able to
486 /// recover some Wasm locals or operand stack values, but it is
487 /// not guaranteed, even when optimizations are disabled.
488 ///
489 /// When this is enabled, additional instrumentation is inserted
490 /// that directly tracks the Wasm VM state at every step. This has
491 /// some performance impact, but allows perfect debugging
492 /// fidelity.
493 ///
494 /// Breakpoints, watchpoints, and stepping are not yet supported,
495 /// but will be added in a future version of Wasmtime.
496 ///
497 /// This enables use of the [`crate::FrameHandle`] API which is
498 /// provided by [`crate::Caller::debug_exit_frames`] or
499 /// [`crate::Store::debug_exit_frames`].
500 ///
501 /// ***Note*** Enabling this option is not compatible with the
502 /// Winch compiler.
503 #[cfg(feature = "debug")]
504 pub fn guest_debug(&mut self, enable: bool) -> &mut Self {
505 self.tunables.debug_guest = Some(enable);
506 self
507 }
508
509 /// Configures whether [`WasmBacktrace`] will be present in the context of
510 /// errors returned from Wasmtime.
511 ///
512 /// This method is deprecated in favor of
513 /// [`Config::wasm_backtrace_max_frames`]. Calling `wasm_backtrace(false)`
514 /// is equivalent to `wasm_backtrace_max_frames(None)`, and
515 /// `wasm_backtrace(true)` will leave `wasm_backtrace_max_frames` unchanged
516 /// if the value is `Some` and will otherwise restore the default `Some`
517 /// value.
518 ///
519 /// [`WasmBacktrace`]: crate::WasmBacktrace
520 #[deprecated = "use `wasm_backtrace_max_frames` instead"]
521 pub fn wasm_backtrace(&mut self, enable: bool) -> &mut Self {
522 match (enable, self.wasm_backtrace_max_frames) {
523 (false, _) => self.wasm_backtrace_max_frames = None,
524 // Wasm backtraces were disabled; enable them with the
525 // default maximum number of frames to capture.
526 (true, None) => {
527 self.wasm_backtrace_max_frames = Some(DEFAULT_WASM_BACKTRACE_MAX_FRAMES)
528 }
529 // Wasm backtraces are already enabled; keep the existing
530 // max-frames configuration.
531 (true, Some(_)) => {}
532 }
533 self
534 }
535
536 /// Configures whether backtraces in `Trap` will parse debug info in the wasm file to
537 /// have filename/line number information.
538 ///
539 /// When enabled this will causes modules to retain debugging information
540 /// found in wasm binaries. This debug information will be used when a trap
541 /// happens to symbolicate each stack frame and attempt to print a
542 /// filename/line number for each wasm frame in the stack trace.
543 ///
544 /// By default this option is `WasmBacktraceDetails::Environment`, meaning
545 /// that wasm will read `WASMTIME_BACKTRACE_DETAILS` to indicate whether
546 /// details should be parsed. Note that the `std` feature of this crate must
547 /// be active to read environment variables, otherwise this is disabled by
548 /// default.
549 pub fn wasm_backtrace_details(&mut self, enable: WasmBacktraceDetails) -> &mut Self {
550 self.wasm_backtrace_details_env_used = false;
551 self.tunables.parse_wasm_debuginfo = match enable {
552 WasmBacktraceDetails::Enable => Some(true),
553 WasmBacktraceDetails::Disable => Some(false),
554 WasmBacktraceDetails::Environment => {
555 #[cfg(feature = "std")]
556 {
557 self.wasm_backtrace_details_env_used = true;
558 std::env::var("WASMTIME_BACKTRACE_DETAILS")
559 .map(|s| Some(s == "1"))
560 .unwrap_or(Some(false))
561 }
562 #[cfg(not(feature = "std"))]
563 {
564 Some(false)
565 }
566 }
567 };
568 self
569 }
570
571 /// Configures the maximum number of WebAssembly frames to collect in
572 /// backtraces.
573 ///
574 /// A backtrace may be collected whenever an error is returned from a host
575 /// function call through to WebAssembly or when WebAssembly itself hits a
576 /// trap condition, such as an out-of-bounds memory access. This flag
577 /// indicates, in these conditions, whether the backtrace is collected or
578 /// not and how many frames should be collected.
579 ///
580 /// Currently wasm backtraces are implemented through frame pointer walking.
581 /// This means that collecting a backtrace is expected to be a fast and
582 /// relatively cheap operation. Additionally backtrace collection is
583 /// suitable in concurrent environments since one thread capturing a
584 /// backtrace won't block other threads.
585 ///
586 /// Collected backtraces are attached via
587 /// [`Error::context`](crate::Error::context) to errors returned from host
588 /// functions. The [`WasmBacktrace`] type can be acquired via
589 /// [`Error::downcast_ref`](crate::Error::downcast_ref) to inspect the
590 /// backtrace. When this option is set to `None` then this context is never
591 /// applied to errors coming out of wasm.
592 ///
593 /// The default value is 20.
594 ///
595 /// [`WasmBacktrace`]: crate::WasmBacktrace
596 pub fn wasm_backtrace_max_frames(&mut self, limit: Option<NonZeroUsize>) -> &mut Self {
597 self.wasm_backtrace_max_frames = limit;
598 self
599 }
600
601 /// Configures whether to generate native unwind information
602 /// (e.g. `.eh_frame` on Linux).
603 ///
604 /// This configuration option only exists to help third-party stack
605 /// capturing mechanisms, such as the system's unwinder or the `backtrace`
606 /// crate, determine how to unwind through Wasm frames. It does not affect
607 /// whether Wasmtime can capture Wasm backtraces or not. The presence of
608 /// [`WasmBacktrace`] is controlled by the
609 /// [`Config::wasm_backtrace_max_frames`] option.
610 ///
611 /// Native unwind information is included:
612 /// - When targeting Windows, since the Windows ABI requires it.
613 /// - By default.
614 ///
615 /// Note that systems loading many modules may wish to disable this
616 /// configuration option instead of leaving it on-by-default. Some platforms
617 /// exhibit quadratic behavior when registering/unregistering unwinding
618 /// information which can greatly slow down the module loading/unloading
619 /// process.
620 ///
621 /// [`WasmBacktrace`]: crate::WasmBacktrace
622 pub fn native_unwind_info(&mut self, enable: bool) -> &mut Self {
623 self.native_unwind_info = Some(enable);
624 self
625 }
626
627 /// Configures whether execution of WebAssembly will "consume fuel" to
628 /// either halt or yield execution as desired.
629 ///
630 /// This can be used to deterministically prevent infinitely-executing
631 /// WebAssembly code by instrumenting generated code to consume fuel as it
632 /// executes. When fuel runs out a trap is raised, however [`Store`] can be
633 /// configured to yield execution periodically via
634 /// [`crate::Store::fuel_async_yield_interval`].
635 ///
636 /// Note that a [`Store`] starts with no fuel, so if you enable this option
637 /// you'll have to be sure to pour some fuel into [`Store`] before
638 /// executing some code.
639 ///
640 /// By default this option is `false`.
641 ///
642 /// [`Store`]: crate::Store
643 pub fn consume_fuel(&mut self, enable: bool) -> &mut Self {
644 self.tunables.consume_fuel = Some(enable);
645 self
646 }
647
648 /// Configures the fuel cost of each WebAssembly operator.
649 ///
650 /// In addition to each operator's flat cost, [`OperatorCost::variable`]
651 /// configures per-byte, per-element, and per-page costs for operators whose
652 /// work depends on a runtime operand.
653 ///
654 /// These costs apply both to operators in function bodies and to operators
655 /// in constant expressions evaluated at instantiation time, such as global
656 /// initializers and element or data segment offsets.
657 ///
658 /// This is only relevant when [`Config::consume_fuel`] is enabled.
659 pub fn operator_cost(&mut self, cost: OperatorCost) -> &mut Self {
660 self.tunables.operator_cost = Some(OperatorCostStrategy::table(cost));
661 self
662 }
663
664 /// Enables epoch-based interruption.
665 ///
666 /// When executing code in async mode, we sometimes want to
667 /// implement a form of cooperative timeslicing: long-running Wasm
668 /// guest code should periodically yield to the executor
669 /// loop. This yielding could be implemented by using "fuel" (see
670 /// [`consume_fuel`](Config::consume_fuel)). However, fuel
671 /// instrumentation is somewhat expensive: it modifies the
672 /// compiled form of the Wasm code so that it maintains a precise
673 /// instruction count, frequently checking this count against the
674 /// remaining fuel. If one does not need this precise count or
675 /// deterministic interruptions, and only needs a periodic
676 /// interrupt of some form, then It would be better to have a more
677 /// lightweight mechanism.
678 ///
679 /// Epoch-based interruption is that mechanism. There is a global
680 /// "epoch", which is a counter that divides time into arbitrary
681 /// periods (or epochs). This counter lives on the
682 /// [`Engine`] and can be incremented by calling
683 /// [`Engine::increment_epoch`].
684 /// Epoch-based instrumentation works by setting a "deadline
685 /// epoch". The compiled code knows the deadline, and at certain
686 /// points, checks the current epoch against that deadline. It
687 /// will yield if the deadline has been reached.
688 ///
689 /// The idea is that checking an infrequently-changing counter is
690 /// cheaper than counting and frequently storing a precise metric
691 /// (instructions executed) locally. The interruptions are not
692 /// deterministic, but if the embedder increments the epoch in a
693 /// periodic way (say, every regular timer tick by a thread or
694 /// signal handler), then we can ensure that all async code will
695 /// yield to the executor within a bounded time.
696 ///
697 /// The [`Store`](crate::Store) tracks the deadline, and controls
698 /// what happens when the deadline is reached during
699 /// execution. Several behaviors are possible:
700 ///
701 /// - Trap if code is executing when the epoch deadline is
702 /// met. See
703 /// [`Store::epoch_deadline_trap`](crate::Store::epoch_deadline_trap).
704 ///
705 /// - Call an arbitrary function. This function may chose to trap or
706 /// increment the epoch. See
707 /// [`Store::epoch_deadline_callback`](crate::Store::epoch_deadline_callback).
708 ///
709 /// - Yield to the executor loop, then resume when the future is
710 /// next polled. See
711 /// [`Store::epoch_deadline_async_yield_and_update`](crate::Store::epoch_deadline_async_yield_and_update).
712 ///
713 /// Trapping is the default. The yielding behaviour may be used for
714 /// the timeslicing behavior described above.
715 ///
716 /// This feature is available with or without async support.
717 /// However, without async support, the timeslicing behaviour is
718 /// not available. This means epoch-based interruption can only
719 /// serve as a simple external-interruption mechanism.
720 ///
721 /// An initial deadline must be set before executing code by calling
722 /// [`Store::set_epoch_deadline`](crate::Store::set_epoch_deadline). If this
723 /// deadline is not configured then wasm will immediately trap.
724 ///
725 /// ## Interaction with blocking host calls
726 ///
727 /// Epochs (and fuel) do not assist in handling WebAssembly code blocked in
728 /// a call to the host. For example if the WebAssembly function calls
729 /// `wasi:io/poll.poll` to sleep epochs will not assist in waking this up or
730 /// timing it out. Epochs intentionally only affect running WebAssembly code
731 /// itself and it's left to the embedder to determine how best to wake up
732 /// indefinitely blocking code in the host.
733 ///
734 /// The typical solution for this, however, is to use the `async` variant of
735 /// WASI host functions. This models computation as a Rust `Future` which
736 /// means that when blocking happens the future is only suspended and
737 /// control yields back to the main event loop. This gives the embedder the
738 /// opportunity to use `tokio::time::timeout` for example on a wasm
739 /// computation and have the desired effect of cancelling a blocking
740 /// operation when a timeout expires.
741 ///
742 /// ## Limitations with malicious guests
743 ///
744 /// Epochs are designed to handle malicious WebAssembly guests -- the
745 /// deadline check cannot be avoided by WebAssembly code. It is safe to use
746 /// epoch deadlines to limit the execution time of untrusted code.
747 ///
748 /// Note, though, that a current limitation to this is that
749 /// bulk-data-transfer instructions, such as `memory.copy`, only check the
750 /// epoch once at the start of the operation. These operations can take a
751 /// variable amount of time to complete based on how many bytes are being
752 /// copied. This means that the maximal time slice a guest might take is
753 /// the maximum of the epoch interval and the largest
754 /// memory-copy-style-instruction executed. The size of a copy is bounded
755 /// on the size of linear memory or GC heap size. In the limit, however, a
756 /// guest using a 64-bit linear memory with a 128GiB size could issue a
757 /// 128GiB `memory.copy` which would have no preemption within the
758 /// instruction itself. Hosts which need strict time limits for guests right
759 /// now are recommended to ensure that the store's allocated heap size
760 /// (linear memory + GC heap) are bounded with a
761 /// [`ResourceLimiter`](crate::ResourceLimiter).
762 ///
763 /// ## When to use fuel vs. epochs
764 ///
765 /// In general, epoch-based interruption results in faster
766 /// execution. This difference is sometimes significant: in some
767 /// measurements, up to 2-3x. This is because epoch-based
768 /// interruption does less work: it only watches for a global
769 /// rarely-changing counter to increment, rather than keeping a
770 /// local frequently-changing counter and comparing it to a
771 /// deadline.
772 ///
773 /// Fuel, in contrast, should be used when *deterministic*
774 /// yielding or trapping is needed. For example, if it is required
775 /// that the same function call with the same starting state will
776 /// always either complete or trap with an out-of-fuel error,
777 /// deterministically, then fuel with a fixed bound should be
778 /// used.
779 ///
780 /// **Note** Enabling this option is not compatible with the Winch compiler.
781 ///
782 /// # See Also
783 ///
784 /// - [`Store::set_epoch_deadline`](crate::Store::set_epoch_deadline)
785 /// - [`Store::epoch_deadline_trap`](crate::Store::epoch_deadline_trap)
786 /// - [`Store::epoch_deadline_callback`](crate::Store::epoch_deadline_callback)
787 /// - [`Store::epoch_deadline_async_yield_and_update`](crate::Store::epoch_deadline_async_yield_and_update)
788 pub fn epoch_interruption(&mut self, enable: bool) -> &mut Self {
789 self.tunables.epoch_interruption = Some(enable);
790 self
791 }
792
793 /// XXX: For internal fuzzing and debugging use only!
794 #[doc(hidden)]
795 pub fn gc_zeal_alloc_counter(&mut self, counter: Option<NonZeroU32>) -> Result<&mut Self> {
796 #[cfg(not(gc_zeal))]
797 {
798 let _ = counter;
799 bail!(
800 "cannot set `gc_zeal_alloc_counter` because Wasmtime was not built with `cfg(gc_zeal)`"
801 );
802 }
803
804 #[cfg(gc_zeal)]
805 {
806 self.tunables.gc_zeal_alloc_counter = Some(counter);
807 Ok(self)
808 }
809 }
810
811 /// Configures the maximum amount of stack space available for
812 /// executing WebAssembly code.
813 ///
814 /// WebAssembly has well-defined semantics on stack overflow. This is
815 /// intended to be a knob which can help configure how much stack space
816 /// wasm execution is allowed to consume. Note that the number here is not
817 /// super-precise, but rather wasm will take at most "pretty close to this
818 /// much" stack space.
819 ///
820 /// If a wasm call (or series of nested wasm calls) take more stack space
821 /// than the `size` specified then a stack overflow trap will be raised.
822 ///
823 /// Caveat: this knob only limits the stack space consumed by wasm code.
824 /// More importantly, it does not ensure that this much stack space is
825 /// available on the calling thread stack. Exhausting the thread stack
826 /// typically leads to an **abort** of the process.
827 ///
828 /// Here are some examples of how that could happen:
829 ///
830 /// - Let's assume this option is set to 2 MiB and then a thread that has
831 /// a stack with 512 KiB left.
832 ///
833 /// If wasm code consumes more than 512 KiB then the process will be aborted.
834 ///
835 /// - Assuming the same conditions, but this time wasm code does not consume
836 /// any stack but calls into a host function. The host function consumes
837 /// more than 512 KiB of stack space. The process will be aborted.
838 ///
839 /// There's another gotcha related to recursive calling into wasm: the stack
840 /// space consumed by a host function is counted towards this limit. The
841 /// host functions are not prevented from consuming more than this limit.
842 /// However, if the host function that used more than this limit and called
843 /// back into wasm, then the execution will trap immediately because of
844 /// stack overflow.
845 ///
846 /// When the `async` feature is enabled, this value cannot exceed the
847 /// `async_stack_size` option. Be careful not to set this value too close
848 /// to `async_stack_size` as doing so may limit how much stack space
849 /// is available for host functions.
850 ///
851 /// By default this option is 512 KiB.
852 ///
853 /// # Errors
854 ///
855 /// The [`Engine::new`] method will fail if the `size` specified here is
856 /// either 0 or larger than the [`Config::async_stack_size`] configuration.
857 pub fn max_wasm_stack(&mut self, size: usize) -> &mut Self {
858 self.max_wasm_stack = size;
859 self
860 }
861
862 /// Configures the size of the stacks used for asynchronous execution.
863 ///
864 /// This setting configures the size of the stacks that are allocated for
865 /// asynchronous execution. The value cannot be less than `max_wasm_stack`.
866 ///
867 /// The amount of stack space guaranteed for host functions is
868 /// `async_stack_size - max_wasm_stack`, so take care not to set these two values
869 /// close to one another; doing so may cause host functions to overflow the
870 /// stack and abort the process.
871 ///
872 /// By default this option is 2 MiB.
873 ///
874 /// # Errors
875 ///
876 /// The [`Engine::new`] method will fail if the value for this option is
877 /// smaller than the [`Config::max_wasm_stack`] option.
878 pub fn async_stack_size(&mut self, size: usize) -> &mut Self {
879 self.async_stack_size = size;
880 self
881 }
882
883 /// Configures whether or not stacks used for async futures are zeroed
884 /// before (re)use.
885 ///
886 /// When the [`call_async`] variant of calling WebAssembly is used
887 /// then Wasmtime will create a separate runtime execution stack for each
888 /// future produced by [`call_async`]. By default upon allocation, depending
889 /// on the platform, these stacks might be filled with uninitialized
890 /// memory. This is safe and correct because, modulo bugs in Wasmtime,
891 /// compiled Wasm code will never read from a stack slot before it
892 /// initializes the stack slot.
893 ///
894 /// However, as a defense-in-depth mechanism, you may configure Wasmtime to
895 /// ensure that these stacks are zeroed before they are used. Notably, if
896 /// you are using the pooling allocator, stacks can be pooled and reused
897 /// across different Wasm guests; ensuring that stacks are zeroed can
898 /// prevent data leakage between Wasm guests even in the face of potential
899 /// read-of-stack-slot-before-initialization bugs in Wasmtime's compiler.
900 ///
901 /// Stack zeroing can be a costly operation in highly concurrent
902 /// environments due to modifications of the virtual address space requiring
903 /// process-wide synchronization. It can also be costly in `no-std`
904 /// environments that must manually zero memory, and cannot rely on an OS
905 /// and virtual memory to provide zeroed pages.
906 ///
907 /// This option defaults to `false`.
908 ///
909 /// [`call_async`]: crate::TypedFunc::call_async
910 pub fn async_stack_zeroing(&mut self, enable: bool) -> &mut Self {
911 self.async_stack_zeroing = enable;
912 self
913 }
914
915 /// Explicitly enables (and un-disables) a given set of [`WasmFeatures`].
916 ///
917 /// Note: this is a low-level method that does not necessarily imply that
918 /// wasmtime _supports_ a feature. It should only be used to _disable_
919 /// features that callers want to be rejected by the parser or _enable_
920 /// features callers are certain that the current configuration of wasmtime
921 /// supports.
922 ///
923 /// Feature validation is deferred until an engine is being built, thus by
924 /// enabling features here a caller may cause
925 /// [`Engine::new`] to fail later, if the feature
926 /// configuration isn't supported.
927 pub fn wasm_features(&mut self, flag: WasmFeatures, enable: bool) -> &mut Self {
928 self.enabled_features.set(flag, enable);
929 self.disabled_features.set(flag, !enable);
930 self
931 }
932
933 /// Configures whether the WebAssembly tail calls proposal will be enabled
934 /// for compilation or not.
935 ///
936 /// The [WebAssembly tail calls proposal] introduces the `return_call` and
937 /// `return_call_indirect` instructions. These instructions allow for Wasm
938 /// programs to implement some recursive algorithms with *O(1)* stack space
939 /// usage.
940 ///
941 /// This is `true` by default.
942 ///
943 /// [WebAssembly tail calls proposal]: https://github.com/WebAssembly/tail-call
944 pub fn wasm_tail_call(&mut self, enable: bool) -> &mut Self {
945 self.wasm_features(WasmFeatures::TAIL_CALL, enable);
946 self
947 }
948
949 /// Configures whether the WebAssembly [branch-hinting] proposal is enabled.
950 ///
951 /// When enabled, the `metadata.code.branch_hint` custom section is parsed
952 /// and used to lay out cold code paths during compilation. The hints are
953 /// advisory and never affect execution semantics.
954 ///
955 /// This is `false` by default until the proposal has been fuzzed.
956 ///
957 /// [branch-hinting]: https://github.com/WebAssembly/branch-hinting
958 pub fn wasm_branch_hinting(&mut self, enable: bool) -> &mut Self {
959 self.tunables.branch_hinting = Some(enable);
960 self
961 }
962
963 /// Configures whether the WebAssembly custom-page-sizes proposal will be
964 /// enabled for compilation or not.
965 ///
966 /// The [WebAssembly custom-page-sizes proposal] allows a memory to
967 /// customize its page sizes. By default, Wasm page sizes are 64KiB
968 /// large. This proposal allows the memory to opt into smaller page sizes
969 /// instead, allowing Wasm to run in environments with less than 64KiB RAM
970 /// available, for example.
971 ///
972 /// Note that the page size is part of the memory's type, and because
973 /// different memories may have different types, they may also have
974 /// different page sizes.
975 ///
976 /// Currently the only valid page sizes are 64KiB (the default) and 1
977 /// byte. Future extensions may relax this constraint and allow all powers
978 /// of two.
979 ///
980 /// Support for this proposal is disabled by default.
981 ///
982 /// [WebAssembly custom-page-sizes proposal]: https://github.com/WebAssembly/custom-page-sizes
983 pub fn wasm_custom_page_sizes(&mut self, enable: bool) -> &mut Self {
984 self.wasm_features(WasmFeatures::CUSTOM_PAGE_SIZES, enable);
985 self
986 }
987
988 /// Configures whether the WebAssembly compact imports proposal is enabled.
989 ///
990 /// The [WebAssembly compact import section proposal]
991 /// adds two compact encodings for imports:
992 /// - A module name and a list of `(item name, type)` pairs
993 /// - A module name, a type, and a list of item names
994 ///
995 /// This reduces redundant module and type listings, and can
996 /// reduce WebAssembly file size, especially in files with many
997 /// repeated imports.
998 ///
999 /// When enabled, compact imports are accepted in binary and text-format inputs.
1000 ///
1001 /// This feature is `false` by default.
1002 ///
1003 /// [WebAssembly compact import section proposal]: https://github.com/WebAssembly/compact-import-section
1004 pub fn wasm_compact_imports(&mut self, enable: bool) -> &mut Self {
1005 self.wasm_features(WasmFeatures::COMPACT_IMPORTS, enable);
1006 self
1007 }
1008
1009 /// Configures whether the WebAssembly [threads] proposal will be enabled
1010 /// for compilation.
1011 ///
1012 /// This feature gates items such as shared memories and atomic
1013 /// instructions. Note that the threads feature depends on the bulk memory
1014 /// feature, which is enabled by default. Additionally note that while the
1015 /// wasm feature is called "threads" it does not actually include the
1016 /// ability to spawn threads. Spawning threads is part of the [wasi-threads]
1017 /// proposal which is a separately gated feature in Wasmtime.
1018 ///
1019 /// Embeddings of Wasmtime are able to build their own custom threading
1020 /// scheme on top of the core wasm threads proposal, however.
1021 ///
1022 /// The default value for this option is whether the `threads`
1023 /// crate feature of Wasmtime is enabled or not. By default this crate
1024 /// feature is enabled.
1025 ///
1026 /// [threads]: https://github.com/webassembly/threads
1027 /// [wasi-threads]: https://github.com/webassembly/wasi-threads
1028 #[cfg(feature = "threads")]
1029 pub fn wasm_threads(&mut self, enable: bool) -> &mut Self {
1030 self.wasm_features(WasmFeatures::THREADS, enable);
1031 self
1032 }
1033
1034 /// Configures whether the WebAssembly [shared-everything-threads] proposal
1035 /// will be enabled for compilation.
1036 ///
1037 /// This feature gates extended use of the `shared` attribute on items other
1038 /// than memories, extra atomic instructions, and new component model
1039 /// intrinsics for spawning threads. It depends on the
1040 /// [`wasm_threads`][Self::wasm_threads] being enabled.
1041 ///
1042 /// [shared-everything-threads]:
1043 /// https://github.com/webassembly/shared-everything-threads
1044 pub fn wasm_shared_everything_threads(&mut self, enable: bool) -> &mut Self {
1045 self.wasm_features(WasmFeatures::SHARED_EVERYTHING_THREADS, enable);
1046 self
1047 }
1048
1049 /// Configures whether the [WebAssembly reference types proposal][proposal]
1050 /// will be enabled for compilation.
1051 ///
1052 /// This feature gates items such as the `externref` and `funcref` types as
1053 /// well as allowing a module to define multiple tables.
1054 ///
1055 /// Note that the reference types proposal depends on the bulk memory proposal.
1056 ///
1057 /// This feature is `true` by default.
1058 ///
1059 /// # Errors
1060 ///
1061 /// The validation of this feature are deferred until the engine is being built,
1062 /// and thus may cause [`Engine::new`] fail if the `bulk_memory` feature is disabled.
1063 ///
1064 /// [proposal]: https://github.com/webassembly/reference-types
1065 #[cfg(feature = "gc")]
1066 pub fn wasm_reference_types(&mut self, enable: bool) -> &mut Self {
1067 self.wasm_features(WasmFeatures::REFERENCE_TYPES, enable);
1068 self
1069 }
1070
1071 /// Configures whether the [WebAssembly function references
1072 /// proposal][proposal] will be enabled for compilation.
1073 ///
1074 /// This feature gates non-nullable reference types, function reference
1075 /// types, `call_ref`, `ref.func`, and non-nullable reference related
1076 /// instructions.
1077 ///
1078 /// Note that the function references proposal depends on the reference
1079 /// types proposal.
1080 ///
1081 /// This feature is `true` by default.
1082 ///
1083 /// [proposal]: https://github.com/WebAssembly/function-references
1084 #[cfg(feature = "gc")]
1085 pub fn wasm_function_references(&mut self, enable: bool) -> &mut Self {
1086 self.wasm_features(WasmFeatures::FUNCTION_REFERENCES, enable);
1087 self
1088 }
1089
1090 /// Configures whether the [WebAssembly wide-arithmetic][proposal] will be
1091 /// enabled for compilation.
1092 ///
1093 /// This feature is `true` by default.
1094 ///
1095 /// [proposal]: https://github.com/WebAssembly/wide-arithmetic
1096 pub fn wasm_wide_arithmetic(&mut self, enable: bool) -> &mut Self {
1097 self.wasm_features(WasmFeatures::WIDE_ARITHMETIC, enable);
1098 self
1099 }
1100
1101 /// Configures whether the [WebAssembly Garbage Collection
1102 /// proposal][proposal] will be enabled for compilation.
1103 ///
1104 /// This feature gates `struct` and `array` type definitions and references,
1105 /// the `i31ref` type, and all related instructions.
1106 ///
1107 /// Note that the function references proposal depends on the typed function
1108 /// references proposal.
1109 ///
1110 /// This feature is `true` by default.
1111 ///
1112 /// [proposal]: https://github.com/WebAssembly/gc
1113 pub fn wasm_gc(&mut self, enable: bool) -> &mut Self {
1114 self.wasm_features(WasmFeatures::GC, enable);
1115 self
1116 }
1117
1118 /// Configures whether the WebAssembly SIMD proposal will be
1119 /// enabled for compilation.
1120 ///
1121 /// The [WebAssembly SIMD proposal][proposal]. This feature gates items such
1122 /// as the `v128` type and all of its operators being in a module. Note that
1123 /// this does not enable the [relaxed simd proposal].
1124 ///
1125 /// **Note**
1126 ///
1127 /// On x86_64 platforms the base CPU feature requirement for SIMD
1128 /// is SSE2 for the Cranelift compiler and AVX for the Winch compiler.
1129 ///
1130 /// This is `true` by default.
1131 ///
1132 /// [proposal]: https://github.com/webassembly/simd
1133 /// [relaxed simd proposal]: https://github.com/WebAssembly/relaxed-simd
1134 pub fn wasm_simd(&mut self, enable: bool) -> &mut Self {
1135 self.wasm_features(WasmFeatures::SIMD, enable);
1136 self
1137 }
1138
1139 /// Configures whether the WebAssembly Relaxed SIMD proposal will be
1140 /// enabled for compilation.
1141 ///
1142 /// The relaxed SIMD proposal adds new instructions to WebAssembly which,
1143 /// for some specific inputs, are allowed to produce different results on
1144 /// different hosts. More-or-less this proposal enables exposing
1145 /// platform-specific semantics of SIMD instructions in a controlled
1146 /// fashion to a WebAssembly program. From an embedder's perspective this
1147 /// means that WebAssembly programs may execute differently depending on
1148 /// whether the host is x86_64 or AArch64, for example.
1149 ///
1150 /// By default Wasmtime lowers relaxed SIMD instructions to the fastest
1151 /// lowering for the platform it's running on. This means that, by default,
1152 /// some relaxed SIMD instructions may have different results for the same
1153 /// inputs across x86_64 and AArch64. This behavior can be disabled through
1154 /// the [`Config::relaxed_simd_deterministic`] option which will force
1155 /// deterministic behavior across all platforms, as classified by the
1156 /// specification, at the cost of performance.
1157 ///
1158 /// This is `true` by default.
1159 ///
1160 /// [proposal]: https://github.com/webassembly/relaxed-simd
1161 pub fn wasm_relaxed_simd(&mut self, enable: bool) -> &mut Self {
1162 self.wasm_features(WasmFeatures::RELAXED_SIMD, enable);
1163 self
1164 }
1165
1166 /// This option can be used to control the behavior of the [relaxed SIMD
1167 /// proposal's][proposal] instructions.
1168 ///
1169 /// The relaxed SIMD proposal introduces instructions that are allowed to
1170 /// have different behavior on different architectures, primarily to afford
1171 /// an efficient implementation on all architectures. This means, however,
1172 /// that the same module may execute differently on one host than another,
1173 /// which typically is not otherwise the case. This option is provided to
1174 /// force Wasmtime to generate deterministic code for all relaxed simd
1175 /// instructions, at the cost of performance, for all architectures. When
1176 /// this option is enabled then the deterministic behavior of all
1177 /// instructions in the relaxed SIMD proposal is selected.
1178 ///
1179 /// This is `false` by default.
1180 ///
1181 /// [proposal]: https://github.com/webassembly/relaxed-simd
1182 pub fn relaxed_simd_deterministic(&mut self, enable: bool) -> &mut Self {
1183 self.tunables.relaxed_simd_deterministic = Some(enable);
1184 self
1185 }
1186
1187 /// Configures whether the [WebAssembly bulk memory operations
1188 /// proposal][proposal] will be enabled for compilation.
1189 ///
1190 /// This feature gates items such as the `memory.copy` instruction, passive
1191 /// data/table segments, etc, being in a module.
1192 ///
1193 /// This is `true` by default.
1194 ///
1195 /// Feature `reference_types`, which is also `true` by default, requires
1196 /// this feature to be enabled. Thus disabling this feature must also disable
1197 /// `reference_types` as well using [`wasm_reference_types`](crate::Config::wasm_reference_types).
1198 ///
1199 /// # Errors
1200 ///
1201 /// Disabling this feature without disabling `reference_types` will cause
1202 /// [`Engine::new`] to fail.
1203 ///
1204 /// [proposal]: https://github.com/webassembly/bulk-memory-operations
1205 pub fn wasm_bulk_memory(&mut self, enable: bool) -> &mut Self {
1206 self.wasm_features(WasmFeatures::BULK_MEMORY, enable);
1207 self
1208 }
1209
1210 /// Configures whether the WebAssembly multi-value [proposal] will
1211 /// be enabled for compilation.
1212 ///
1213 /// This feature gates functions and blocks returning multiple values in a
1214 /// module, for example.
1215 ///
1216 /// This is `true` by default.
1217 ///
1218 /// [proposal]: https://github.com/webassembly/multi-value
1219 pub fn wasm_multi_value(&mut self, enable: bool) -> &mut Self {
1220 self.wasm_features(WasmFeatures::MULTI_VALUE, enable);
1221 self
1222 }
1223
1224 /// Configures whether the WebAssembly multi-memory [proposal] will
1225 /// be enabled for compilation.
1226 ///
1227 /// This feature gates modules having more than one linear memory
1228 /// declaration or import.
1229 ///
1230 /// This is `true` by default.
1231 ///
1232 /// [proposal]: https://github.com/webassembly/multi-memory
1233 pub fn wasm_multi_memory(&mut self, enable: bool) -> &mut Self {
1234 self.wasm_features(WasmFeatures::MULTI_MEMORY, enable);
1235 self
1236 }
1237
1238 /// Configures whether the WebAssembly memory64 [proposal] will
1239 /// be enabled for compilation.
1240 ///
1241 /// Note that this the upstream specification is not finalized and Wasmtime
1242 /// may also have bugs for this feature since it hasn't been exercised
1243 /// much.
1244 ///
1245 /// This is `false` by default.
1246 ///
1247 /// [proposal]: https://github.com/webassembly/memory64
1248 pub fn wasm_memory64(&mut self, enable: bool) -> &mut Self {
1249 self.wasm_features(WasmFeatures::MEMORY64, enable);
1250 self
1251 }
1252
1253 /// Configures whether the WebAssembly extended-const [proposal] will
1254 /// be enabled for compilation.
1255 ///
1256 /// This is `true` by default.
1257 ///
1258 /// [proposal]: https://github.com/webassembly/extended-const
1259 pub fn wasm_extended_const(&mut self, enable: bool) -> &mut Self {
1260 self.wasm_features(WasmFeatures::EXTENDED_CONST, enable);
1261 self
1262 }
1263
1264 /// Configures whether the [WebAssembly stack switching
1265 /// proposal][proposal] will be enabled for compilation.
1266 ///
1267 /// This feature gates the use of control tags.
1268 ///
1269 /// This feature depends on the `function_reference_types` and
1270 /// `exceptions` features.
1271 ///
1272 /// This feature is `false` by default.
1273 ///
1274 /// # Errors
1275 ///
1276 /// [proposal]: https://github.com/webassembly/stack-switching
1277 pub fn wasm_stack_switching(&mut self, enable: bool) -> &mut Self {
1278 self.wasm_features(WasmFeatures::STACK_SWITCHING, enable);
1279 self
1280 }
1281
1282 /// Configures whether the WebAssembly component-model [proposal] will
1283 /// be enabled for compilation.
1284 ///
1285 /// This flag can be used to blanket disable all components within Wasmtime.
1286 /// Otherwise usage of components requires statically using
1287 /// [`Component`](crate::component::Component) instead of
1288 /// [`Module`](crate::Module) for example anyway.
1289 ///
1290 /// The default value for this option is whether the `component-model`
1291 /// crate feature of Wasmtime is enabled or not. By default this crate
1292 /// feature is enabled.
1293 ///
1294 /// [proposal]: https://github.com/webassembly/component-model
1295 #[cfg(feature = "component-model")]
1296 pub fn wasm_component_model(&mut self, enable: bool) -> &mut Self {
1297 self.wasm_features(WasmFeatures::COMPONENT_MODEL, enable);
1298 self
1299 }
1300
1301 /// Configures whether components support the async ABI [proposal] for
1302 /// lifting and lowering functions, as well as `stream`, `future`, and
1303 /// `error-context` types.
1304 ///
1305 /// Please note that Wasmtime's support for this feature is _very_
1306 /// incomplete.
1307 ///
1308 /// [proposal]:
1309 /// https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1310 #[cfg(feature = "component-model-async")]
1311 pub fn wasm_component_model_async(&mut self, enable: bool) -> &mut Self {
1312 self.wasm_features(WasmFeatures::CM_ASYNC, enable);
1313 self
1314 }
1315
1316 /// This corresponds to the 🚝 emoji in the component model specification.
1317 ///
1318 /// Please note that Wasmtime's support for this feature is _very_
1319 /// incomplete.
1320 ///
1321 /// [proposal]:
1322 /// https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1323 #[cfg(feature = "component-model-async")]
1324 pub fn wasm_component_model_more_async_builtins(&mut self, enable: bool) -> &mut Self {
1325 self.wasm_features(WasmFeatures::CM_MORE_ASYNC_BUILTINS, enable);
1326 self
1327 }
1328
1329 /// This corresponds to the 🚟 emoji in the component model specification.
1330 ///
1331 /// Please note that Wasmtime's support for this feature is _very_
1332 /// incomplete.
1333 ///
1334 /// [proposal]: https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1335 #[cfg(feature = "component-model-async")]
1336 pub fn wasm_component_model_async_stackful(&mut self, enable: bool) -> &mut Self {
1337 self.wasm_features(WasmFeatures::CM_ASYNC_STACKFUL, enable);
1338 self
1339 }
1340
1341 /// This corresponds to the 🧵 emoji in the component model specification.
1342 ///
1343 /// Please note that Wasmtime's support for this feature is _very_
1344 /// incomplete.
1345 ///
1346 /// [proposal]:
1347 /// https://github.com/WebAssembly/component-model/pull/557
1348 #[cfg(feature = "component-model-async")]
1349 pub fn wasm_component_model_threading(&mut self, enable: bool) -> &mut Self {
1350 self.wasm_features(WasmFeatures::CM_THREADING, enable);
1351 self
1352 }
1353
1354 /// This corresponds to the 📝 emoji in the component model specification.
1355 ///
1356 /// Please note that Wasmtime's support for this feature is _very_
1357 /// incomplete.
1358 ///
1359 /// [proposal]: https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1360 #[cfg(feature = "component-model")]
1361 pub fn wasm_component_model_error_context(&mut self, enable: bool) -> &mut Self {
1362 self.wasm_features(WasmFeatures::CM_ERROR_CONTEXT, enable);
1363 self
1364 }
1365
1366 /// Configures whether the [GC extension to the component-model
1367 /// proposal][proposal] is enabled or not.
1368 ///
1369 /// This corresponds to the 🛸 emoji in the component model specification.
1370 ///
1371 /// Please note that Wasmtime's support for this feature is _very_
1372 /// incomplete.
1373 ///
1374 /// [proposal]: https://github.com/WebAssembly/component-model/issues/525
1375 #[cfg(feature = "component-model")]
1376 pub fn wasm_component_model_gc(&mut self, enable: bool) -> &mut Self {
1377 self.wasm_features(WasmFeatures::CM_GC, enable);
1378 self
1379 }
1380
1381 /// Configures whether the component model map type is enabled or not.
1382 ///
1383 /// This is part of the component model specification and enables the
1384 /// `map<k, v>` type in WIT and the component binary format.
1385 #[cfg(feature = "component-model")]
1386 pub fn wasm_component_model_map(&mut self, enable: bool) -> &mut Self {
1387 self.wasm_features(WasmFeatures::CM_MAP, enable);
1388 self
1389 }
1390
1391 /// Configures whether the component model memory64 support is enabled
1392 ///
1393 /// This corresponds to the 🐘 emoji in the component model specification.
1394 ///
1395 /// Please note that Wasmtime's support for this feature is _very_
1396 /// incomplete.
1397 #[cfg(feature = "component-model")]
1398 pub fn wasm_component_model_memory64(&mut self, enable: bool) -> &mut Self {
1399 self.wasm_features(WasmFeatures::CM64, enable);
1400 self
1401 }
1402
1403 /// This corresponds to the 🔧 emoji in the component model specification.
1404 ///
1405 /// Please note that Wasmtime's support for this feature is _very_
1406 /// incomplete.
1407 #[cfg(feature = "component-model")]
1408 pub fn wasm_component_model_fixed_length_lists(&mut self, enable: bool) -> &mut Self {
1409 self.wasm_features(WasmFeatures::CM_FIXED_LENGTH_LISTS, enable);
1410 self
1411 }
1412
1413 /// This corresponds to the 🏷️ emoji in the component model specification.
1414 ///
1415 /// Please note that Wasmtime's support for this feature is a work in
1416 /// progress.
1417 #[cfg(feature = "component-model")]
1418 pub fn wasm_component_model_implements(&mut self, enable: bool) -> &mut Self {
1419 self.wasm_features(WasmFeatures::CM_IMPLEMENTS, enable);
1420 self
1421 }
1422
1423 /// This corresponds to the 🔗 emoji in the component model specification.
1424 ///
1425 /// Please note that Wasmtime's support for this feature is a work in
1426 /// progress.
1427 #[cfg(feature = "component-model")]
1428 pub fn wasm_component_model_canonical_names(&mut self, enable: bool) -> &mut Self {
1429 self.wasm_features(WasmFeatures::CM_CANON_NAMES, enable);
1430 self
1431 }
1432
1433 /// Configures whether the [Exception-handling proposal][proposal] is enabled or not.
1434 ///
1435 /// This is `true` by default.
1436 ///
1437 /// [proposal]: https://github.com/WebAssembly/exception-handling
1438 #[cfg(feature = "gc")]
1439 pub fn wasm_exceptions(&mut self, enable: bool) -> &mut Self {
1440 self.wasm_features(WasmFeatures::EXCEPTIONS, enable);
1441 self
1442 }
1443
1444 #[doc(hidden)] // FIXME(#3427) - if/when implemented then un-hide this
1445 #[deprecated = "This configuration option only exists for internal \
1446 usage with the spec testsuite. It may be removed at \
1447 any time and without warning. Do not rely on it!"]
1448 pub fn wasm_legacy_exceptions(&mut self, enable: bool) -> &mut Self {
1449 self.wasm_features(WasmFeatures::LEGACY_EXCEPTIONS, enable);
1450 self
1451 }
1452
1453 /// Configures which compilation strategy will be used for wasm modules.
1454 ///
1455 /// This method can be used to configure which compiler is used for wasm
1456 /// modules, and for more documentation consult the [`Strategy`] enumeration
1457 /// and its documentation.
1458 ///
1459 /// The default value for this is `Strategy::Auto`.
1460 ///
1461 /// # Panics
1462 ///
1463 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1464 #[cfg(any(feature = "cranelift", feature = "winch"))]
1465 pub fn strategy(&mut self, strategy: Strategy) -> &mut Self {
1466 self.compiler_config_mut().strategy = strategy.not_auto();
1467 self
1468 }
1469
1470 /// Configures which garbage collector will be used for Wasm modules.
1471 ///
1472 /// This method can be used to configure which garbage collector
1473 /// implementation is used for Wasm modules. For more documentation, consult
1474 /// the [`Collector`] enumeration and its documentation.
1475 ///
1476 /// The default value for this is `Collector::Auto`.
1477 #[cfg(feature = "gc")]
1478 pub fn collector(&mut self, collector: Collector) -> &mut Self {
1479 self.collector = collector;
1480 self
1481 }
1482
1483 /// Configures the initial size, in bytes, of each store's GC heap.
1484 ///
1485 /// By default all GC heaps start out at 0 bytes in size and must grow
1486 /// upwards from there. Growth happens incrementally as GC pressure happens
1487 /// and memory runs out. The amount being grown by is additionally a
1488 /// heuristic of the size of the failed allocation. By providing an initial
1489 /// size of a store's GC heap embedders can more tightly control initial
1490 /// parameters to optimize workloads that might have a predictable pattern.
1491 /// For example if workloads frequently have less than a certain threshold
1492 /// of size then that could be configured as the initial size here to avoid
1493 /// growths happening over time.
1494 ///
1495 /// Note that like WebAssembly linear memories the GC heap does not start
1496 /// with committed memory equal to this size. Instead memory is reserved,
1497 /// but then lazily allocated by the OS on access. In other words it should
1498 /// be relatively cheap to increase this value to help amortize initial
1499 /// startup cost of wasm modules.
1500 ///
1501 /// The `bytes` size is rounded up to the GC heap's page size.
1502 ///
1503 /// This only configures the initially-allocated size of the GC heap; the
1504 /// heap can still grow beyond it on demand. It is separate from
1505 /// [`Config::gc_heap_reservation`], which configures the size of the
1506 /// virtual-memory reservation (and therefore how far the heap can grow
1507 /// in place).
1508 ///
1509 /// The default value for this is 0.
1510 pub fn gc_heap_initial_size(&mut self, bytes: u64) -> &mut Self {
1511 self.tunables.gc_heap_initial_size = Some(bytes);
1512 self
1513 }
1514
1515 /// Creates a default profiler based on the profiling strategy chosen.
1516 ///
1517 /// Profiler creation calls the type's default initializer where the purpose is
1518 /// really just to put in place the type used for profiling.
1519 ///
1520 /// Some [`ProfilingStrategy`] require specific platforms or particular feature
1521 /// to be enabled, such as `ProfilingStrategy::JitDump` requires the `jitdump`
1522 /// feature.
1523 ///
1524 /// # Errors
1525 ///
1526 /// The validation of this field is deferred until the engine is being built, and thus may
1527 /// cause [`Engine::new`] fail if the required feature is disabled, or the platform is not
1528 /// supported.
1529 pub fn profiler(&mut self, profile: ProfilingStrategy) -> &mut Self {
1530 self.profiling_strategy = profile;
1531 self
1532 }
1533
1534 /// Configures whether the debug verifier of Cranelift is enabled or not.
1535 ///
1536 /// When Cranelift is used as a code generation backend this will configure
1537 /// it to have the `enable_verifier` flag which will enable a number of debug
1538 /// checks inside of Cranelift. This is largely only useful for the
1539 /// developers of wasmtime itself.
1540 ///
1541 /// The default value for this is `false`
1542 ///
1543 /// # Panics
1544 ///
1545 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1546 #[cfg(any(feature = "cranelift", feature = "winch"))]
1547 pub fn cranelift_debug_verifier(&mut self, enable: bool) -> &mut Self {
1548 let val = if enable { "true" } else { "false" };
1549 self.compiler_config_mut().settings.insert(
1550 "enable_verifier".to_string(),
1551 (val.to_string(), UserSpecified::No),
1552 );
1553 self
1554 }
1555
1556 /// Configures whether extra debug checks are inserted into
1557 /// Wasmtime-generated code by Cranelift.
1558 ///
1559 /// The default value for this is `false`
1560 ///
1561 /// # Panics
1562 ///
1563 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1564 #[cfg(any(feature = "cranelift", feature = "winch"))]
1565 pub fn cranelift_wasmtime_debug_checks(&mut self, enable: bool) -> &mut Self {
1566 unsafe { self.cranelift_flag_set("wasmtime_debug_checks", &enable.to_string()) }
1567 }
1568
1569 /// Configures the Cranelift code generator optimization level.
1570 ///
1571 /// When the Cranelift code generator is used you can configure the
1572 /// optimization level used for generated code in a few various ways. For
1573 /// more information see the documentation of [`OptLevel`].
1574 ///
1575 /// The default value for this is `OptLevel::Speed`.
1576 ///
1577 /// # Panics
1578 ///
1579 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1580 #[cfg(any(feature = "cranelift", feature = "winch"))]
1581 pub fn cranelift_opt_level(&mut self, level: OptLevel) -> &mut Self {
1582 let val = match level {
1583 OptLevel::None => "none",
1584 OptLevel::Speed => "speed",
1585 OptLevel::SpeedAndSize => "speed_and_size",
1586 };
1587 self.compiler_config_mut().settings.insert(
1588 "opt_level".to_string(),
1589 (val.to_string(), UserSpecified::No),
1590 );
1591 self
1592 }
1593
1594 /// Configures the regalloc algorithm used by the Cranelift code generator.
1595 ///
1596 /// Cranelift can select any of several register allocator algorithms. Each
1597 /// of these algorithms generates correct code, but they represent different
1598 /// tradeoffs between compile speed (how expensive the compilation process
1599 /// is) and run-time speed (how fast the generated code runs).
1600 /// For more information see the documentation of [`RegallocAlgorithm`].
1601 ///
1602 /// The default value for this is `RegallocAlgorithm::Backtracking`.
1603 ///
1604 /// # Panics
1605 ///
1606 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1607 #[cfg(any(feature = "cranelift", feature = "winch"))]
1608 pub fn cranelift_regalloc_algorithm(&mut self, algo: RegallocAlgorithm) -> &mut Self {
1609 let val = match algo {
1610 RegallocAlgorithm::Backtracking => "backtracking",
1611 RegallocAlgorithm::SinglePass => "single_pass",
1612 };
1613 self.compiler_config_mut().settings.insert(
1614 "regalloc_algorithm".to_string(),
1615 (val.to_string(), UserSpecified::No),
1616 );
1617 self
1618 }
1619
1620 /// Configures whether Cranelift should perform a NaN-canonicalization pass.
1621 ///
1622 /// When Cranelift is used as a code generation backend this will configure
1623 /// it to replace NaNs with a single canonical value. This is useful for
1624 /// users requiring entirely deterministic WebAssembly computation. This is
1625 /// not required by the WebAssembly spec, so it is not enabled by default.
1626 ///
1627 /// Note that this option affects not only WebAssembly's `f32` and `f64`
1628 /// types but additionally the `v128` type. This option will cause
1629 /// operations using any of these types to have extra checks placed after
1630 /// them to normalize NaN values as needed.
1631 ///
1632 /// The default value for this is `false`
1633 ///
1634 /// # Panics
1635 ///
1636 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1637 #[cfg(any(feature = "cranelift", feature = "winch"))]
1638 pub fn cranelift_nan_canonicalization(&mut self, enable: bool) -> &mut Self {
1639 let val = if enable { "true" } else { "false" };
1640 self.compiler_config_mut().settings.insert(
1641 "enable_nan_canonicalization".to_string(),
1642 (val.to_string(), UserSpecified::No),
1643 );
1644 self
1645 }
1646
1647 /// Allows setting a Cranelift boolean flag or preset. This allows
1648 /// fine-tuning of Cranelift settings.
1649 ///
1650 /// Since Cranelift flags may be unstable, this method should not be considered to be stable
1651 /// either; other `Config` functions should be preferred for stability.
1652 ///
1653 /// # Safety
1654 ///
1655 /// This is marked as unsafe, because setting the wrong flag might break invariants,
1656 /// resulting in execution hazards.
1657 ///
1658 /// # Errors
1659 ///
1660 /// The validation of the flags are deferred until the engine is being built, and thus may
1661 /// cause [`Engine::new`] fail if the flag's name does not exist, or the value is not appropriate
1662 /// for the flag type.
1663 ///
1664 /// # Panics
1665 ///
1666 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1667 #[cfg(any(feature = "cranelift", feature = "winch"))]
1668 pub unsafe fn cranelift_flag_enable(&mut self, flag: &str) -> &mut Self {
1669 self.compiler_config_mut()
1670 .flags
1671 .insert(flag.to_string(), UserSpecified::Yes);
1672 self
1673 }
1674
1675 /// Allows settings another Cranelift flag defined by a flag name and value. This allows
1676 /// fine-tuning of Cranelift settings.
1677 ///
1678 /// Since Cranelift flags may be unstable, this method should not be considered to be stable
1679 /// either; other `Config` functions should be preferred for stability.
1680 ///
1681 /// # Safety
1682 ///
1683 /// This is marked as unsafe, because setting the wrong flag might break invariants,
1684 /// resulting in execution hazards.
1685 ///
1686 /// # Errors
1687 ///
1688 /// The validation of the flags are deferred until the engine is being built, and thus may
1689 /// cause [`Engine::new`] fail if the flag's name does not exist, or incompatible with other
1690 /// settings.
1691 ///
1692 /// For example, feature `wasm_backtrace` will set `unwind_info` to `true`, but if it's
1693 /// manually set to false then it will fail.
1694 ///
1695 /// # Panics
1696 ///
1697 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1698 #[cfg(any(feature = "cranelift", feature = "winch"))]
1699 pub unsafe fn cranelift_flag_set(&mut self, name: &str, value: &str) -> &mut Self {
1700 self.compiler_config_mut()
1701 .settings
1702 .insert(name.to_string(), (value.to_string(), UserSpecified::Yes));
1703 self
1704 }
1705
1706 /// Set a custom [`Cache`].
1707 ///
1708 /// To load a cache configuration from a file, use [`Cache::from_file`]. Otherwise, you can
1709 /// create a new cache config using [`CacheConfig::new`] and passing that to [`Cache::new`].
1710 ///
1711 /// If you want to disable the cache, you can call this method with `None`.
1712 ///
1713 /// By default, new configs do not have caching enabled.
1714 /// Every call to [`Module::new(my_wasm)`][crate::Module::new] will recompile `my_wasm`,
1715 /// even when it is unchanged, unless an enabled `CacheConfig` is provided.
1716 ///
1717 /// This method is only available when the `cache` feature of this crate is
1718 /// enabled.
1719 ///
1720 /// [docs]: https://bytecodealliance.github.io/wasmtime/cli-cache.html
1721 #[cfg(feature = "cache")]
1722 pub fn cache(&mut self, cache: Option<Cache>) -> &mut Self {
1723 self.cache = cache;
1724 self
1725 }
1726
1727 /// Sets a custom memory creator.
1728 ///
1729 /// Custom memory creators are used when creating host `Memory` objects or when
1730 /// creating instance linear memories for the on-demand instance allocation strategy.
1731 #[cfg(feature = "runtime")]
1732 pub fn with_host_memory(&mut self, mem_creator: Arc<dyn MemoryCreator>) -> &mut Self {
1733 self.mem_creator = Some(Arc::new(MemoryCreatorProxy(mem_creator)));
1734 self
1735 }
1736
1737 /// Sets a custom stack creator.
1738 ///
1739 /// Custom memory creators are used when creating creating async instance stacks for
1740 /// the on-demand instance allocation strategy.
1741 #[cfg(feature = "async")]
1742 pub fn with_host_stack(&mut self, stack_creator: Arc<dyn StackCreator>) -> &mut Self {
1743 self.stack_creator = Some(Arc::new(StackCreatorProxy(stack_creator)));
1744 self
1745 }
1746
1747 /// Sets a custom executable-memory publisher.
1748 ///
1749 /// Custom executable-memory publishers are hooks that allow
1750 /// Wasmtime to make certain regions of memory executable when
1751 /// loading precompiled modules or compiling new modules
1752 /// in-process. In most modern operating systems, memory allocated
1753 /// for heap usage is readable and writable by default but not
1754 /// executable. To jump to machine code stored in that memory, we
1755 /// need to make it executable. For security reasons, we usually
1756 /// also make it read-only at the same time, so the executing code
1757 /// can't be modified later.
1758 ///
1759 /// By default, Wasmtime will use the appropriate system calls on
1760 /// the host platform for this work. However, it also allows
1761 /// plugging in a custom implementation via this configuration
1762 /// option. This may be useful on custom or `no_std` platforms,
1763 /// for example, especially where virtual memory is not otherwise
1764 /// used by Wasmtime (no `signals-and-traps` feature).
1765 #[cfg(feature = "runtime")]
1766 pub fn with_custom_code_memory(
1767 &mut self,
1768 custom_code_memory: Option<Arc<dyn CustomCodeMemory>>,
1769 ) -> &mut Self {
1770 self.custom_code_memory = custom_code_memory;
1771 self
1772 }
1773
1774 /// Sets the instance allocation strategy to use.
1775 ///
1776 /// This is notably used in conjunction with
1777 /// [`InstanceAllocationStrategy::Pooling`] and [`PoolingAllocationConfig`].
1778 pub fn allocation_strategy(
1779 &mut self,
1780 strategy: impl Into<InstanceAllocationStrategy>,
1781 ) -> &mut Self {
1782 self.allocation_strategy = strategy.into();
1783 self
1784 }
1785
1786 /// Specifies the capacity of linear memories, in bytes, in their initial
1787 /// allocation.
1788 ///
1789 /// > Note: this value has important performance ramifications, be sure to
1790 /// > benchmark when setting this to a non-default value and read over this
1791 /// > documentation.
1792 ///
1793 /// This function will change the size of the initial memory allocation made
1794 /// for linear memories. This setting is only applicable when the initial
1795 /// size of a linear memory is below this threshold. Linear memories are
1796 /// allocated in the virtual address space of the host process with OS APIs
1797 /// such as `mmap` and this setting affects how large the allocation will
1798 /// be.
1799 ///
1800 /// ## Background: WebAssembly Linear Memories
1801 ///
1802 /// WebAssembly linear memories always start with a minimum size and can
1803 /// possibly grow up to a maximum size. The minimum size is always specified
1804 /// in a WebAssembly module itself and the maximum size can either be
1805 /// optionally specified in the module or inherently limited by the index
1806 /// type. For example for this module:
1807 ///
1808 /// ```wasm
1809 /// (module
1810 /// (memory $a 4)
1811 /// (memory $b 4096 4096 (pagesize 1))
1812 /// (memory $c i64 10)
1813 /// )
1814 /// ```
1815 ///
1816 /// * Memory `$a` initially allocates 4 WebAssembly pages (256KiB) and can
1817 /// grow up to 4GiB, the limit of the 32-bit index space.
1818 /// * Memory `$b` initially allocates 4096 WebAssembly pages, but in this
1819 /// case its page size is 1, so it's 4096 bytes. Memory can also grow no
1820 /// further meaning that it will always be 4096 bytes.
1821 /// * Memory `$c` is a 64-bit linear memory which starts with 640KiB of
1822 /// memory and can theoretically grow up to 2^64 bytes, although most
1823 /// hosts will run out of memory long before that.
1824 ///
1825 /// All operations on linear memories done by wasm are required to be
1826 /// in-bounds. Any access beyond the end of a linear memory is considered a
1827 /// trap.
1828 ///
1829 /// ## What this setting affects: Virtual Memory
1830 ///
1831 /// This setting is used to configure the behavior of the size of the linear
1832 /// memory allocation performed for each of these memories. For example the
1833 /// initial linear memory allocation looks like this:
1834 ///
1835 /// ```text
1836 /// memory_reservation
1837 /// |
1838 /// ◄─────────┴────────────────►
1839 /// ┌───────┬─────────┬──────────────────┬───────┐
1840 /// │ guard │ initial │ ... capacity ... │ guard │
1841 /// └───────┴─────────┴──────────────────┴───────┘
1842 /// ◄──┬──► ◄──┬──►
1843 /// │ │
1844 /// │ memory_guard_size
1845 /// │
1846 /// │
1847 /// memory_guard_size (if guard_before_linear_memory)
1848 /// ```
1849 ///
1850 /// Memory in the `initial` range is accessible to the instance and can be
1851 /// read/written by wasm code. Memory in the `guard` regions is never
1852 /// accessible to wasm code and memory in `capacity` is initially
1853 /// inaccessible but may become accessible through `memory.grow` instructions
1854 /// for example.
1855 ///
1856 /// This means that this setting is the size of the initial chunk of virtual
1857 /// memory that a linear memory may grow into.
1858 ///
1859 /// ## What this setting affects: Runtime Speed
1860 ///
1861 /// This is a performance-sensitive setting which is taken into account
1862 /// during the compilation process of a WebAssembly module. For example if a
1863 /// 32-bit WebAssembly linear memory has a `memory_reservation` size of 4GiB
1864 /// then bounds checks can be elided because `capacity` will be guaranteed
1865 /// to be unmapped for all addressable bytes that wasm can access (modulo a
1866 /// few details).
1867 ///
1868 /// If `memory_reservation` was something smaller like 256KiB then that
1869 /// would have a much smaller impact on virtual memory but the compile code
1870 /// would then need to have explicit bounds checks to ensure that
1871 /// loads/stores are in-bounds.
1872 ///
1873 /// The goal of this setting is to enable skipping bounds checks in most
1874 /// modules by default. Some situations which require explicit bounds checks
1875 /// though are:
1876 ///
1877 /// * When `memory_reservation` is smaller than the addressable size of the
1878 /// linear memory. For example if 64-bit linear memories always need
1879 /// bounds checks as they can address the entire virtual address spacce.
1880 /// For 32-bit linear memories a `memory_reservation` minimum size of 4GiB
1881 /// is required to elide bounds checks.
1882 ///
1883 /// * When linear memories have a page size of 1 then bounds checks are
1884 /// required. In this situation virtual memory can't be relied upon
1885 /// because that operates at the host page size granularity where wasm
1886 /// requires a per-byte level granularity.
1887 ///
1888 /// * Configuration settings such as [`Config::signals_based_traps`] can be
1889 /// used to disable the use of signal handlers and virtual memory so
1890 /// explicit bounds checks are required.
1891 ///
1892 /// * When [`Config::memory_guard_size`] is too small a bounds check may be
1893 /// required. For 32-bit wasm addresses are actually 33-bit effective
1894 /// addresses because loads/stores have a 32-bit static offset to add to
1895 /// the dynamic 32-bit address. If the static offset is larger than the
1896 /// size of the guard region then an explicit bounds check is required.
1897 ///
1898 /// ## What this setting affects: Memory Growth Behavior
1899 ///
1900 /// In addition to affecting bounds checks emitted in compiled code this
1901 /// setting also affects how WebAssembly linear memories are grown. The
1902 /// `memory.grow` instruction can be used to make a linear memory larger and
1903 /// this is also affected by APIs such as
1904 /// [`Memory::grow`](crate::Memory::grow).
1905 ///
1906 /// In these situations when the amount being grown is small enough to fit
1907 /// within the remaining capacity then the linear memory doesn't have to be
1908 /// moved at runtime. If the capacity runs out though then a new linear
1909 /// memory allocation must be made and the contents of linear memory is
1910 /// copied over.
1911 ///
1912 /// For example here's a situation where a copy happens:
1913 ///
1914 /// * The `memory_reservation` setting is configured to 128KiB.
1915 /// * A WebAssembly linear memory starts with a single 64KiB page.
1916 /// * This memory can be grown by one page to contain the full 128KiB of
1917 /// memory.
1918 /// * If grown by one more page, though, then a 192KiB allocation must be
1919 /// made and the previous 128KiB of contents are copied into the new
1920 /// allocation.
1921 ///
1922 /// This growth behavior can have a significant performance impact if lots
1923 /// of data needs to be copied on growth. Conversely if memory growth never
1924 /// needs to happen because the capacity will always be large enough then
1925 /// optimizations can be applied to cache the base pointer of linear memory.
1926 ///
1927 /// When memory is grown then the
1928 /// [`Config::memory_reservation_for_growth`] is used for the new
1929 /// memory allocation to have memory to grow into.
1930 ///
1931 /// When using the pooling allocator via [`PoolingAllocationConfig`] then
1932 /// memories are never allowed to move so requests for growth are instead
1933 /// rejected with an error.
1934 ///
1935 /// ## When this setting is not used
1936 ///
1937 /// This setting is ignored and unused when the initial size of linear
1938 /// memory is larger than this threshold. For example if this setting is set
1939 /// to 1MiB but a wasm module requires a 2MiB minimum allocation then this
1940 /// setting is ignored. In this situation the minimum size of memory will be
1941 /// allocated along with [`Config::memory_reservation_for_growth`]
1942 /// after it to grow into.
1943 ///
1944 /// That means that this value can be set to zero. That can be useful in
1945 /// benchmarking to see the overhead of bounds checks for example.
1946 /// Additionally it can be used to minimize the virtual memory allocated by
1947 /// Wasmtime.
1948 ///
1949 /// ## Default Value
1950 ///
1951 /// The default value for this property depends on the host platform. For
1952 /// 64-bit platforms there's lots of address space available, so the default
1953 /// configured here is 4GiB. When coupled with the default size of
1954 /// [`Config::memory_guard_size`] this means that 32-bit WebAssembly linear
1955 /// memories with 64KiB page sizes will skip almost all bounds checks by
1956 /// default.
1957 ///
1958 /// For 32-bit platforms this value defaults to 10MiB. This means that
1959 /// bounds checks will be required on 32-bit platforms.
1960 pub fn memory_reservation(&mut self, bytes: u64) -> &mut Self {
1961 self.tunables.memory_reservation = Some(bytes);
1962 self
1963 }
1964
1965 /// Indicates whether linear memories may relocate their base pointer at
1966 /// runtime.
1967 ///
1968 /// WebAssembly linear memories either have a maximum size that's explicitly
1969 /// listed in the type of a memory or inherently limited by the index type
1970 /// of the memory (e.g. 4GiB for 32-bit linear memories). Depending on how
1971 /// the linear memory is allocated (see [`Config::memory_reservation`]) it
1972 /// may be necessary to move the memory in the host's virtual address space
1973 /// during growth. This option controls whether this movement is allowed or
1974 /// not.
1975 ///
1976 /// An example of a linear memory needing to move is when
1977 /// [`Config::memory_reservation`] is 0 then a linear memory will be
1978 /// allocated as the minimum size of the memory plus
1979 /// [`Config::memory_reservation_for_growth`]. When memory grows beyond the
1980 /// reservation for growth then the memory needs to be relocated.
1981 ///
1982 /// When this option is set to `false` then it can have a number of impacts
1983 /// on how memories work at runtime:
1984 ///
1985 /// * Modules can be compiled with static knowledge the base pointer of
1986 /// linear memory never changes to enable optimizations such as
1987 /// loop invariant code motion (hoisting the base pointer out of a loop).
1988 ///
1989 /// * Memories cannot grow in excess of their original allocation. This
1990 /// means that [`Config::memory_reservation`] and
1991 /// [`Config::memory_reservation_for_growth`] may need tuning to ensure
1992 /// the memory configuration works at runtime.
1993 ///
1994 /// The default value for this option is `true`.
1995 pub fn memory_may_move(&mut self, enable: bool) -> &mut Self {
1996 self.tunables.memory_may_move = Some(enable);
1997 self
1998 }
1999
2000 /// Configures the size, in bytes, of the guard region used at the end of a
2001 /// linear memory's address space reservation.
2002 ///
2003 /// > Note: this value has important performance ramifications, be sure to
2004 /// > understand what this value does before tweaking it and benchmarking.
2005 ///
2006 /// This setting controls how many bytes are guaranteed to be unmapped after
2007 /// the virtual memory allocation of a linear memory. When
2008 /// combined with sufficiently large values of
2009 /// [`Config::memory_reservation`] (e.g. 4GiB for 32-bit linear memories)
2010 /// then a guard region can be used to eliminate bounds checks in generated
2011 /// code.
2012 ///
2013 /// This setting additionally can be used to help deduplicate bounds checks
2014 /// in code that otherwise requires bounds checks. For example with a 4KiB
2015 /// guard region then a 64-bit linear memory which accesses addresses `x+8`
2016 /// and `x+16` only needs to perform a single bounds check on `x`. If that
2017 /// bounds check passes then the offset is guaranteed to either reside in
2018 /// linear memory or the guard region, resulting in deterministic behavior
2019 /// either way.
2020 ///
2021 /// ## How big should the guard be?
2022 ///
2023 /// In general, like with configuring [`Config::memory_reservation`], you
2024 /// probably don't want to change this value from the defaults. Removing
2025 /// bounds checks is dependent on a number of factors where the size of the
2026 /// guard region is only one piece of the equation. Other factors include:
2027 ///
2028 /// * [`Config::memory_reservation`]
2029 /// * The index type of the linear memory (e.g. 32-bit or 64-bit)
2030 /// * The page size of the linear memory
2031 /// * Other settings such as [`Config::signals_based_traps`]
2032 ///
2033 /// Embeddings using virtual memory almost always want at least some guard
2034 /// region, but otherwise changes from the default should be profiled
2035 /// locally to see the performance impact.
2036 ///
2037 /// ## Default
2038 ///
2039 /// The default value for this property is 32MiB on 64-bit platforms. This
2040 /// allows eliminating almost all bounds checks on loads/stores with an
2041 /// immediate offset of less than 32MiB. On 32-bit platforms this defaults
2042 /// to 64KiB.
2043 pub fn memory_guard_size(&mut self, bytes: u64) -> &mut Self {
2044 self.tunables.memory_guard_size = Some(bytes);
2045 self
2046 }
2047
2048 /// Configures the size, in bytes, of the extra virtual memory space
2049 /// reserved after a linear memory is relocated.
2050 ///
2051 /// This setting is used in conjunction with [`Config::memory_reservation`]
2052 /// to configure what happens after a linear memory is relocated in the host
2053 /// address space. If the initial size of a linear memory exceeds
2054 /// [`Config::memory_reservation`] or if it grows beyond that size
2055 /// throughout its lifetime then this setting will be used.
2056 ///
2057 /// When a linear memory is relocated it will initially look like this:
2058 ///
2059 /// ```text
2060 /// memory.size
2061 /// │
2062 /// ◄──────┴─────►
2063 /// ┌───────┬──────────────┬───────┐
2064 /// │ guard │ accessible │ guard │
2065 /// └───────┴──────────────┴───────┘
2066 /// ◄──┬──►
2067 /// │
2068 /// memory_guard_size
2069 /// ```
2070 ///
2071 /// where `accessible` needs to be grown but there's no more memory to grow
2072 /// into. A new region of the virtual address space will be allocated that
2073 /// looks like this:
2074 ///
2075 /// ```text
2076 /// memory_reservation_for_growth
2077 /// │
2078 /// memory.size │
2079 /// │ │
2080 /// ◄──────┴─────► ◄─────────────┴───────────►
2081 /// ┌───────┬──────────────┬───────────────────────────┬───────┐
2082 /// │ guard │ accessible │ .. reserved for growth .. │ guard │
2083 /// └───────┴──────────────┴───────────────────────────┴───────┘
2084 /// ◄──┬──►
2085 /// │
2086 /// memory_guard_size
2087 /// ```
2088 ///
2089 /// This means that up to `memory_reservation_for_growth` bytes can be
2090 /// allocated again before the entire linear memory needs to be moved again
2091 /// when another `memory_reservation_for_growth` bytes will be appended to
2092 /// the size of the allocation.
2093 ///
2094 /// Note that this is a currently simple heuristic for optimizing the growth
2095 /// of dynamic memories, primarily implemented for the memory64 proposal
2096 /// where the maximum size of memory is larger than 4GiB. This setting is
2097 /// unlikely to be a one-size-fits-all style approach and if you're an
2098 /// embedder running into issues with growth and are interested in having
2099 /// other growth strategies available here please feel free to [open an
2100 /// issue on the Wasmtime repository][issue]!
2101 ///
2102 /// [issue]: https://github.com/bytecodealliance/wasmtime/issues/new
2103 ///
2104 /// ## Default
2105 ///
2106 /// For 64-bit platforms this defaults to 2GiB, and for 32-bit platforms
2107 /// this defaults to 1MiB.
2108 pub fn memory_reservation_for_growth(&mut self, bytes: u64) -> &mut Self {
2109 self.tunables.memory_reservation_for_growth = Some(bytes);
2110 self
2111 }
2112
2113 /// Configures the initial size, in bytes, to be allocated for GC heaps.
2114 ///
2115 /// This is similar to [`Config::memory_reservation`] but applies to the GC
2116 /// heap rather than to linear memories. See that method for more details
2117 /// on what "reservation" means and the implications of this setting.
2118 ///
2119 /// ## Default
2120 ///
2121 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2122 /// default to the same values as their `memory_*` counterparts. Otherwise,
2123 /// the default value for this property depends on the host platform: for
2124 /// 64-bit platforms this defaults to 4GiB, and for 32-bit platforms this
2125 /// defaults to 10MiB.
2126 pub fn gc_heap_reservation(&mut self, bytes: u64) -> &mut Self {
2127 self.tunables.gc_heap_reservation = Some(bytes);
2128 self
2129 }
2130
2131 /// Configures the size, in bytes, of the guard page region for GC heaps.
2132 ///
2133 /// This is similar to [`Config::memory_guard_size`] but applies to the GC
2134 /// heap rather than to linear memories. See that method for more details on
2135 /// what guard pages are and the implications of this setting.
2136 ///
2137 /// ## Default
2138 ///
2139 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2140 /// default to the same values as their `memory_*` counterparts. Otherwise,
2141 /// the default value for this property is 32MiB on 64-bit platforms and
2142 /// 64KiB on 32-bit platforms.
2143 pub fn gc_heap_guard_size(&mut self, bytes: u64) -> &mut Self {
2144 self.tunables.gc_heap_guard_size = Some(bytes);
2145 self
2146 }
2147
2148 /// Configures the size, in bytes, of the extra virtual memory space
2149 /// reserved after a GC heap is relocated.
2150 ///
2151 /// This is similar to [`Config::memory_reservation_for_growth`] but applies
2152 /// to the GC heap rather than to linear memories. See that method for more
2153 /// details.
2154 ///
2155 /// ## Default
2156 ///
2157 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2158 /// default to the same values as their `memory_*` counterparts. Otherwise,
2159 /// for 64-bit platforms this defaults to 2GiB, and for 32-bit platforms
2160 /// this defaults to 1MiB.
2161 pub fn gc_heap_reservation_for_growth(&mut self, bytes: u64) -> &mut Self {
2162 self.tunables.gc_heap_reservation_for_growth = Some(bytes);
2163 self
2164 }
2165
2166 /// Indicates whether GC heaps are allowed to be reallocated after initial
2167 /// allocation at runtime.
2168 ///
2169 /// This is similar to [`Config::memory_may_move`] but applies to the GC
2170 /// heap rather than to linear memories. See that method for more details.
2171 ///
2172 /// ## Default
2173 ///
2174 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2175 /// default to the same values as their `memory_*` counterparts. Otherwise,
2176 /// the default value for this option is `true`.
2177 pub fn gc_heap_may_move(&mut self, enable: bool) -> &mut Self {
2178 self.tunables.gc_heap_may_move = Some(enable);
2179 self
2180 }
2181
2182 /// Indicates whether a guard region is present before allocations of
2183 /// linear memory.
2184 ///
2185 /// Guard regions before linear memories are never used during normal
2186 /// operation of WebAssembly modules, even if they have out-of-bounds
2187 /// loads. The only purpose for a preceding guard region in linear memory
2188 /// is extra protection against possible bugs in code generators like
2189 /// Cranelift. This setting does not affect performance in any way, but will
2190 /// result in larger virtual memory reservations for linear memories (it
2191 /// won't actually ever use more memory, just use more of the address
2192 /// space).
2193 ///
2194 /// The size of the guard region before linear memory is the same as the
2195 /// guard size that comes after linear memory, which is configured by
2196 /// [`Config::memory_guard_size`].
2197 ///
2198 /// ## Default
2199 ///
2200 /// This value defaults to `true`.
2201 pub fn guard_before_linear_memory(&mut self, enable: bool) -> &mut Self {
2202 self.tunables.guard_before_linear_memory = Some(enable);
2203 self
2204 }
2205
2206 /// Indicates whether to initialize tables lazily, so that instantiation
2207 /// is fast but indirect calls are a little slower. If false, tables
2208 /// are initialized eagerly during instantiation from any active element
2209 /// segments that apply to them.
2210 ///
2211 /// **Note** Disabling this option is not compatible with the Winch compiler.
2212 ///
2213 /// ## Default
2214 ///
2215 /// This value defaults to `true`.
2216 pub fn table_lazy_init(&mut self, table_lazy_init: bool) -> &mut Self {
2217 self.tunables.table_lazy_init = Some(table_lazy_init);
2218 self
2219 }
2220
2221 /// Configure the version information used in serialized and deserialized [`crate::Module`]s.
2222 /// This effects the behavior of [`crate::Module::serialize()`], as well as
2223 /// [`crate::Module::deserialize()`] and related functions.
2224 ///
2225 /// The default strategy is to use the wasmtime crate's Cargo package version.
2226 pub fn module_version(&mut self, strategy: ModuleVersionStrategy) -> Result<&mut Self> {
2227 match strategy {
2228 // This case requires special precondition for assertion in SerializedModule::to_bytes
2229 ModuleVersionStrategy::Custom(ref v) => {
2230 if v.as_bytes().len() > 255 {
2231 bail!("custom module version cannot be more than 255 bytes: {v}");
2232 }
2233 }
2234 _ => {}
2235 }
2236 self.module_version = strategy;
2237 Ok(self)
2238 }
2239
2240 /// Configure whether wasmtime should compile a module using multiple
2241 /// threads.
2242 ///
2243 /// Disabling this will result in a single thread being used to compile
2244 /// the wasm bytecode.
2245 ///
2246 /// By default parallel compilation is enabled.
2247 #[cfg(feature = "parallel-compilation")]
2248 pub fn parallel_compilation(&mut self, parallel: bool) -> &mut Self {
2249 self.parallel_compilation = parallel;
2250 self
2251 }
2252
2253 /// Configures whether compiled artifacts will contain information to map
2254 /// native program addresses back to the original wasm module.
2255 ///
2256 /// This configuration option is `true` by default and, if enabled,
2257 /// generates the appropriate tables in compiled modules to map from native
2258 /// address back to wasm source addresses. This is used for displaying wasm
2259 /// program counters in backtraces as well as generating filenames/line
2260 /// numbers if so configured as well (and the original wasm module has DWARF
2261 /// debugging information present).
2262 pub fn generate_address_map(&mut self, generate: bool) -> &mut Self {
2263 self.tunables.generate_address_map = Some(generate);
2264 self
2265 }
2266
2267 /// Configures whether copy-on-write memory-mapped data is used to
2268 /// initialize a linear memory.
2269 ///
2270 /// Initializing linear memory via a copy-on-write mapping can drastically
2271 /// improve instantiation costs of a WebAssembly module because copying
2272 /// memory is deferred. Additionally if a page of memory is only ever read
2273 /// from WebAssembly and never written too then the same underlying page of
2274 /// data will be reused between all instantiations of a module meaning that
2275 /// if a module is instantiated many times this can lower the overall memory
2276 /// required needed to run that module.
2277 ///
2278 /// The main disadvantage of copy-on-write initialization, however, is that
2279 /// it may be possible for highly-parallel scenarios to be less scalable. If
2280 /// a page is read initially by a WebAssembly module then that page will be
2281 /// mapped to a read-only copy shared between all WebAssembly instances. If
2282 /// the same page is then written, however, then a private copy is created
2283 /// and swapped out from the read-only version. This also requires an [IPI],
2284 /// however, which can be a significant bottleneck in high-parallelism
2285 /// situations.
2286 ///
2287 /// This feature is only applicable when a WebAssembly module meets specific
2288 /// criteria to be initialized in this fashion, such as:
2289 ///
2290 /// * Only memories defined in the module can be initialized this way.
2291 /// * Data segments for memory must use statically known offsets.
2292 /// * Data segments for memory must all be in-bounds.
2293 ///
2294 /// Modules which do not meet these criteria will fall back to
2295 /// initialization of linear memory based on copying memory.
2296 ///
2297 /// This feature of Wasmtime is also platform-specific:
2298 ///
2299 /// * Linux - this feature is supported for all instances of [`Module`].
2300 /// Modules backed by an existing mmap (such as those created by
2301 /// [`Module::deserialize_file`]) will reuse that mmap to cow-initialize
2302 /// memory. Other instance of [`Module`] may use the `memfd_create`
2303 /// syscall to create an initialization image to `mmap`.
2304 /// * Unix (not Linux) - this feature is only supported when loading modules
2305 /// from a precompiled file via [`Module::deserialize_file`] where there
2306 /// is a file descriptor to use to map data into the process. Note that
2307 /// the module must have been compiled with this setting enabled as well.
2308 /// * Windows - there is no support for this feature at this time. Memory
2309 /// initialization will always copy bytes.
2310 ///
2311 /// By default this option is enabled.
2312 ///
2313 /// [`Module::deserialize_file`]: crate::Module::deserialize_file
2314 /// [`Module`]: crate::Module
2315 /// [IPI]: https://en.wikipedia.org/wiki/Inter-processor_interrupt
2316 pub fn memory_init_cow(&mut self, enable: bool) -> &mut Self {
2317 self.tunables.memory_init_cow = Some(enable);
2318 self
2319 }
2320
2321 /// A configuration option to force the usage of `memfd_create` on Linux to
2322 /// be used as the backing source for a module's initial memory image.
2323 ///
2324 /// When [`Config::memory_init_cow`] is enabled, which is enabled by
2325 /// default, module memory initialization images are taken from a module's
2326 /// original mmap if possible. If a precompiled module was loaded from disk
2327 /// this means that the disk's file is used as an mmap source for the
2328 /// initial linear memory contents. This option can be used to force, on
2329 /// Linux, that instead of using the original file on disk a new in-memory
2330 /// file is created with `memfd_create` to hold the contents of the initial
2331 /// image.
2332 ///
2333 /// This option can be used to avoid possibly loading the contents of memory
2334 /// from disk through a page fault. Instead with `memfd_create` the contents
2335 /// of memory are always in RAM, meaning that even page faults which
2336 /// initially populate a wasm linear memory will only work with RAM instead
2337 /// of ever hitting the disk that the original precompiled module is stored
2338 /// on.
2339 ///
2340 /// This option is disabled by default.
2341 pub fn force_memory_init_memfd(&mut self, enable: bool) -> &mut Self {
2342 self.force_memory_init_memfd = enable;
2343 self
2344 }
2345
2346 /// Configures whether or not a coredump should be generated and attached to
2347 /// the [`Error`](crate::Error) when a trap is raised.
2348 ///
2349 /// This option is disabled by default.
2350 #[cfg(feature = "coredump")]
2351 pub fn coredump_on_trap(&mut self, enable: bool) -> &mut Self {
2352 self.coredump_on_trap = enable;
2353 self
2354 }
2355
2356 /// Enables memory error checking for wasm programs.
2357 ///
2358 /// This option is disabled by default.
2359 ///
2360 /// # Panics
2361 ///
2362 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
2363 #[cfg(any(feature = "cranelift", feature = "winch"))]
2364 pub fn wmemcheck(&mut self, enable: bool) -> &mut Self {
2365 self.wmemcheck = enable;
2366 self.compiler_config_mut().wmemcheck = enable;
2367 self
2368 }
2369
2370 /// Configures the "guaranteed dense image size" for copy-on-write
2371 /// initialized memories.
2372 ///
2373 /// When using the [`Config::memory_init_cow`] feature to initialize memory
2374 /// efficiently (which is enabled by default), compiled modules contain an
2375 /// image of the module's initial heap. If the module has a fairly sparse
2376 /// initial heap, with just a few data segments at very different offsets,
2377 /// this could result in a large region of zero bytes in the image. In
2378 /// other words, it's not very memory-efficient.
2379 ///
2380 /// We normally use a heuristic to avoid this: if less than half
2381 /// of the initialized range (first non-zero to last non-zero
2382 /// byte) of any memory in the module has pages with nonzero
2383 /// bytes, then we avoid creating a memory image for the entire module.
2384 ///
2385 /// However, if the embedder always needs the instantiation-time efficiency
2386 /// of copy-on-write initialization, and is otherwise carefully controlling
2387 /// parameters of the modules (for example, by limiting the maximum heap
2388 /// size of the modules), then it may be desirable to ensure a memory image
2389 /// is created even if this could go against the heuristic above. Thus, we
2390 /// add another condition: there is a size of initialized data region up to
2391 /// which we *always* allow a memory image. The embedder can set this to a
2392 /// known maximum heap size if they desire to always get the benefits of
2393 /// copy-on-write images.
2394 ///
2395 /// In the future we may implement a "best of both worlds"
2396 /// solution where we have a dense image up to some limit, and
2397 /// then support a sparse list of initializers beyond that; this
2398 /// would get most of the benefit of copy-on-write and pay the incremental
2399 /// cost of eager initialization only for those bits of memory
2400 /// that are out-of-bounds. However, for now, an embedder desiring
2401 /// fast instantiation should ensure that this setting is as large
2402 /// as the maximum module initial memory content size.
2403 ///
2404 /// By default this value is 16 MiB.
2405 pub fn memory_guaranteed_dense_image_size(&mut self, size_in_bytes: u64) -> &mut Self {
2406 self.memory_guaranteed_dense_image_size = size_in_bytes;
2407 self
2408 }
2409
2410 /// Whether to enable function inlining during compilation or not.
2411 ///
2412 /// This may result in faster execution at runtime, but adds additional
2413 /// compilation time. Inlining may also enlarge the size of compiled
2414 /// artifacts (for example, the size of the result of
2415 /// [`Engine::precompile_component`]).
2416 ///
2417 /// Inlining is not supported by all of Wasmtime's compilation strategies;
2418 /// currently, it only Cranelift supports it. This setting will be ignored
2419 /// when using a compilation strategy that does not support inlining, like
2420 /// Winch.
2421 ///
2422 /// The default value for this is `Inlining::No`.
2423 pub fn compiler_inlining(&mut self, inlining: Inlining) -> &mut Self {
2424 self.tunables.inlining = Some(inlining);
2425 self
2426 }
2427
2428 /// Returns the set of features that the currently selected compiler backend
2429 /// does not support at all and may panic on.
2430 ///
2431 /// Wasmtime strives to reject unknown modules or unsupported modules with
2432 /// first-class errors instead of panics. Not all compiler backends have the
2433 /// same level of feature support on all platforms as well. This method
2434 /// returns a set of features that the currently selected compiler
2435 /// configuration is known to not support and may panic on. This acts as a
2436 /// first-level filter on incoming wasm modules/configuration to fail-fast
2437 /// instead of panicking later on.
2438 ///
2439 /// Note that if a feature is not returned here it does not mean that the
2440 /// backend fully supports the proposal. Instead that means that the backend
2441 /// doesn't ever panic on the proposal, but errors during compilation may
2442 /// still be returned. This means that features listed here are definitely
2443 /// not supported at all, but features not listed here may still be
2444 /// partially supported. For example at the time of this writing the Winch
2445 /// backend partially supports simd so it's not listed here. Winch doesn't
2446 /// fully support simd but unimplemented instructions just return errors.
2447 fn compiler_panicking_wasm_features(&self) -> WasmFeatures {
2448 // First we compute the set of features that Wasmtime itself knows;
2449 // this is a sort of "maximal set" that we invert to create a set
2450 // of features we _definitely can't support_ because wasmtime
2451 // has never heard of them.
2452 let features_known_to_wasmtime = WasmFeatures::WASM3
2453 | WasmFeatures::SHARED_EVERYTHING_THREADS
2454 | WasmFeatures::COMPONENT_MODEL
2455 | WasmFeatures::CUSTOM_PAGE_SIZES
2456 | WasmFeatures::COMPACT_IMPORTS
2457 | WasmFeatures::STACK_SWITCHING
2458 | WasmFeatures::WIDE_ARITHMETIC
2459 | WasmFeatures::CM_ASYNC
2460 | WasmFeatures::CM_ASYNC_STACKFUL
2461 | WasmFeatures::CM_MORE_ASYNC_BUILTINS
2462 | WasmFeatures::CM_THREADING
2463 | WasmFeatures::CM_ERROR_CONTEXT
2464 | WasmFeatures::CM_GC
2465 | WasmFeatures::CM_MAP
2466 | WasmFeatures::CM64
2467 | WasmFeatures::CM_FIXED_LENGTH_LISTS
2468 | WasmFeatures::CM_IMPLEMENTS
2469 | WasmFeatures::CM_CANON_NAMES;
2470
2471 #[allow(unused_mut, reason = "easier to avoid #[cfg]")]
2472 let mut unsupported = !features_known_to_wasmtime;
2473
2474 #[cfg(any(feature = "cranelift", feature = "winch"))]
2475 match self.compiler_config.as_ref().and_then(|c| c.strategy) {
2476 None | Some(Strategy::Cranelift) => {
2477 // Pulley at this time fundamentally doesn't support the
2478 // `threads` proposal, notably shared memory, because Rust can't
2479 // safely implement loads/stores in the face of shared memory.
2480 // Stack switching is not implemented, either.
2481 if self.compiler_target().is_pulley() {
2482 unsupported |= WasmFeatures::THREADS;
2483 unsupported |= WasmFeatures::STACK_SWITCHING;
2484 }
2485
2486 use target_lexicon::*;
2487 match self.compiler_target() {
2488 Triple {
2489 architecture: Architecture::X86_64 | Architecture::X86_64h,
2490 operating_system:
2491 OperatingSystem::Linux
2492 | OperatingSystem::MacOSX(_)
2493 | OperatingSystem::Darwin(_),
2494 ..
2495 } => {
2496 // Stack switching supported on (non-Pulley) Cranelift.
2497 }
2498
2499 _ => {
2500 // On platforms other than x64 Unix-like, we don't
2501 // support stack switching.
2502 unsupported |= WasmFeatures::STACK_SWITCHING;
2503 }
2504 }
2505 }
2506 Some(Strategy::Winch) => {
2507 unsupported |= WasmFeatures::GC
2508 | WasmFeatures::FUNCTION_REFERENCES
2509 | WasmFeatures::RELAXED_SIMD
2510 | WasmFeatures::LEGACY_EXCEPTIONS
2511 | WasmFeatures::STACK_SWITCHING;
2512
2513 match self.compiler_target().architecture {
2514 target_lexicon::Architecture::Aarch64(_) => {
2515 unsupported |= WasmFeatures::THREADS;
2516 }
2517
2518 // Winch doesn't support other non-x64 architectures at this
2519 // time either but will return an first-class error for
2520 // them.
2521 _ => {}
2522 }
2523 }
2524 Some(Strategy::Auto) => unreachable!(),
2525 }
2526 unsupported
2527 }
2528
2529 /// Calculates the set of features that are enabled for this `Config`.
2530 ///
2531 /// This is a bit of a subtle function which takes into account inputs such
2532 /// as the default set of features Wasmtime has enabled, the currently
2533 /// enabled compiler, the currently enabled target, compile-time crate
2534 /// features, and explicitly configured wasm proposals. This function does
2535 /// not return a fixed set of all proposals in all cases as it's a bit more
2536 /// nuanced than that.
2537 ///
2538 /// This method internally will start with an empty set of features to
2539 /// avoid being tied to wasmparser's defaults. Next Wasmtime's set of
2540 /// default features are added to this set, some of which are conditional
2541 /// depending on crate features. Finally explicitly requested features via
2542 /// `wasm_*` methods on `Config` are applied. Everything is then validated
2543 /// later in `Config::validate`.
2544 ///
2545 /// Note that the validation later on in `Config::validate` is a crucial
2546 /// step here. The returned features here might include features unsupported
2547 /// at compile time or unsupported by the selected compiler. In that case
2548 /// `Config::validate` will present a first-class error message indicating
2549 /// what's going on, and users should in theory be able to understand "ok
2550 /// yeah that's why I can't enable that feature here".
2551 fn features(&self) -> WasmFeatures {
2552 // Start with an empty set of wasm features. This notably decouples
2553 // features in Wasmtime from features in wasmparser as the two are
2554 // generally on different timelines.
2555 let mut features = WasmFeatures::empty();
2556
2557 // Next add in all on-by-default features that Wasmtime has which are
2558 // subject to the criteria at
2559 // https://docs.wasmtime.dev/contributing-implementing-wasm-proposals.html
2560 // and https://docs.wasmtime.dev/stability-wasm-proposals.html.
2561 //
2562 // Note that the first entry here, `WASM3`, is a fixed feature set that
2563 // won't change over time in wasmparser which represents the union of
2564 // all on-by-default features in Wasmtime. Also note that this is
2565 // further refined in the conditional section below based on crate
2566 // features.
2567 features |= WasmFeatures::WASM3;
2568
2569 features |= WasmFeatures::WIDE_ARITHMETIC;
2570 // features |= WasmFeatures::YOUR_WASM_FEATURE;
2571 // ...
2572
2573 // NB: if you add a feature above this line please double-check
2574 // https://docs.wasmtime.dev/stability-wasm-proposals.html
2575 // to ensure all requirements are met and/or update the documentation
2576 // there too.
2577
2578 // Next configure some features further based on compile-time features
2579 // of the wasmtime crate itself. For example if "gc" is disabled then
2580 // `GC_TYPES` are disabled (a wasmparser pseudo-feature) as well as
2581 // exceptions, but reference-types is still available (e.g. new
2582 // encodings/types/etc).
2583 //
2584 // These features are all "on by default" in effect but dependent on
2585 // compile-time support being available.
2586 features.set(WasmFeatures::GC_TYPES, cfg!(feature = "gc"));
2587 features.set(WasmFeatures::EXCEPTIONS, cfg!(feature = "gc"));
2588 features.set(WasmFeatures::THREADS, cfg!(feature = "threads"));
2589 features.set(
2590 WasmFeatures::COMPONENT_MODEL,
2591 cfg!(feature = "component-model"),
2592 );
2593 features.set(
2594 WasmFeatures::CM_ASYNC,
2595 self.tunables
2596 .concurrency_support
2597 .unwrap_or(cfg!(feature = "component-model-async")),
2598 );
2599
2600 // Next disable any features which the current compiler/target do not
2601 // support. This handles cases where Winch, for example, doesn't
2602 // implement a feature yet but Cranelift does. Or maybe Cranelift only
2603 // supports one particular platform and not others. Things like that.
2604 features = features & !self.compiler_panicking_wasm_features();
2605
2606 // And, finally, process all explicitly enabled/disabled features on
2607 // behalf of the embedder's frobbing `Config::wasm_*`. These have the
2608 // highest priority since they were explicitly requested.
2609 debug_assert!((self.enabled_features & self.disabled_features).is_empty());
2610 features &= !self.disabled_features;
2611 features |= self.enabled_features;
2612
2613 features
2614 }
2615
2616 /// Returns the configured compiler target for this `Config`.
2617 pub(crate) fn compiler_target(&self) -> target_lexicon::Triple {
2618 // If a target is explicitly configured, always use that.
2619 if let Some(target) = self.target.clone() {
2620 return target;
2621 }
2622
2623 // If the `build.rs` script determined that this platform uses pulley by
2624 // default, then use Pulley.
2625 if cfg!(default_target_pulley) {
2626 return target_lexicon::Triple::pulley_host();
2627 }
2628
2629 // And at this point the target is for sure the host.
2630 target_lexicon::Triple::host()
2631 }
2632
2633 /// Returns `true` if any of the `gc_heap_*` tunables have been explicitly
2634 /// configured.
2635 fn any_gc_heap_tunables_configured(&self) -> bool {
2636 self.tunables.gc_heap_reservation.is_some()
2637 || self.tunables.gc_heap_guard_size.is_some()
2638 || self.tunables.gc_heap_reservation_for_growth.is_some()
2639 || self.tunables.gc_heap_may_move.is_some()
2640 }
2641
2642 pub(crate) fn validate(&self) -> Result<(Tunables, WasmFeatures)> {
2643 let features = self.features();
2644
2645 // First validate that the selected compiler backend and configuration
2646 // supports the set of `features` that are enabled. This will help
2647 // provide more first class errors instead of panics about unsupported
2648 // features and configurations.
2649 let unsupported = features & self.compiler_panicking_wasm_features();
2650 if !unsupported.is_empty() {
2651 for flag in WasmFeatures::FLAGS.iter() {
2652 if !unsupported.contains(*flag.value()) {
2653 continue;
2654 }
2655 bail!(
2656 "the wasm_{} feature is not supported on this compiler configuration",
2657 flag.name().to_lowercase()
2658 );
2659 }
2660
2661 panic!("should have returned an error by now")
2662 }
2663
2664 if self.max_wasm_stack > self.async_stack_size {
2665 bail!("max_wasm_stack size cannot exceed the async_stack_size");
2666 }
2667 if self.max_wasm_stack == 0 {
2668 bail!("max_wasm_stack size cannot be zero");
2669 }
2670 if !cfg!(feature = "wmemcheck") && self.wmemcheck {
2671 bail!("wmemcheck (memory checker) was requested but is not enabled in this build");
2672 }
2673
2674 if !cfg!(feature = "gc") && features.gc_types() {
2675 bail!("support for GC was disabled at compile time")
2676 }
2677
2678 if !cfg!(feature = "gc") && features.contains(WasmFeatures::EXCEPTIONS) {
2679 bail!("exceptions support requires garbage collection (GC) to be enabled in the build");
2680 }
2681
2682 match &self.rr_config {
2683 #[cfg(feature = "rr")]
2684 RRConfig::Recording | RRConfig::Replaying => {
2685 self.validate_rr_determinism_conflicts()?;
2686 }
2687 RRConfig::None => {}
2688 };
2689
2690 let mut tunables = Tunables::default_for_target(&self.compiler_target())?;
2691
2692 // By default this is enabled with the Cargo feature, and if the feature
2693 // is missing this is disabled.
2694 tunables.concurrency_support = cfg!(feature = "component-model-async");
2695
2696 #[cfg(feature = "rr")]
2697 {
2698 tunables.recording = matches!(self.rr_config, RRConfig::Recording);
2699 }
2700
2701 // If no target is explicitly specified then further refine `tunables`
2702 // for the configuration of this host depending on what platform
2703 // features were found available at compile time. This means that anyone
2704 // cross-compiling for a customized host will need to further refine
2705 // compilation options.
2706 if self.target.is_none() {
2707 // If this platform doesn't have native signals then change some
2708 // defaults to account for that. Note that VM guards are turned off
2709 // here because that's primarily a feature of eliding
2710 // bounds-checks.
2711 if !cfg!(has_native_signals) {
2712 tunables.signals_based_traps = cfg!(has_native_signals);
2713 tunables.memory_guard_size = 0;
2714 tunables.gc_heap_guard_size = 0;
2715 }
2716
2717 // When virtual memory is not available use slightly different
2718 // defaults for tunables to be more amenable to `MallocMemory`.
2719 // Note that these can still be overridden by config options.
2720 if !cfg!(has_virtual_memory) {
2721 tunables.memory_reservation = 0;
2722 tunables.memory_reservation_for_growth = 1 << 20; // 1MB
2723 tunables.memory_init_cow = false;
2724 tunables.gc_heap_reservation = 0;
2725 tunables.gc_heap_reservation_for_growth = 1 << 20; // 1MB
2726 }
2727 }
2728
2729 // If guest-debugging is enabled, we must disable
2730 // signals-based traps. Do this before we process the user's
2731 // provided tunables settings so we can detect a conflict with
2732 // an explicit request to use signals-based traps.
2733 #[cfg(feature = "debug")]
2734 if self.tunables.debug_guest == Some(true) {
2735 tunables.signals_based_traps = false;
2736 }
2737
2738 // Inlining currently falls over with the `stack_switch` instruction.
2739 #[cfg(any(feature = "cranelift", feature = "winch"))]
2740 if features.contains(WasmFeatures::STACK_SWITCHING) {
2741 if let Some(inlining) = self.tunables.inlining
2742 && inlining != Inlining::No
2743 {
2744 bail!("cannot enable compiler inlining when stack switching is enabled");
2745 }
2746 tunables.inlining = Inlining::No;
2747 }
2748
2749 self.tunables.configure(&mut tunables);
2750
2751 // If no GC heap tunables are explicitly configured, copy the memory
2752 // tunables' configured values so that GC heaps default to the same
2753 // configuration as linear memories.
2754 if !self.any_gc_heap_tunables_configured() {
2755 tunables.gc_heap_reservation = tunables.memory_reservation;
2756 tunables.gc_heap_guard_size = tunables.memory_guard_size;
2757 tunables.gc_heap_reservation_for_growth = tunables.memory_reservation_for_growth;
2758 tunables.gc_heap_may_move = tunables.memory_may_move;
2759 }
2760
2761 // If we're going to compile with winch, we must use the winch calling convention.
2762 #[cfg(any(feature = "cranelift", feature = "winch"))]
2763 {
2764 tunables.winch_callable = self
2765 .compiler_config
2766 .as_ref()
2767 .is_some_and(|c| c.strategy == Some(Strategy::Winch));
2768 }
2769
2770 tunables.collector = if features.gc_types() {
2771 #[cfg(feature = "gc")]
2772 {
2773 use wasmtime_environ::Collector as EnvCollector;
2774 Some(match self.collector.try_not_auto()? {
2775 Collector::DeferredReferenceCounting => EnvCollector::DeferredReferenceCounting,
2776 Collector::Null => EnvCollector::Null,
2777 Collector::Copying => EnvCollector::Copying,
2778 Collector::Auto => unreachable!(),
2779 })
2780 }
2781 #[cfg(not(feature = "gc"))]
2782 bail!("cannot use GC types: the `gc` feature was disabled at compile time")
2783 } else {
2784 None
2785 };
2786
2787 if tunables.debug_guest {
2788 ensure!(
2789 cfg!(feature = "debug"),
2790 "debug instrumentation support was disabled at compile time"
2791 );
2792 ensure!(
2793 !tunables.signals_based_traps,
2794 "cannot use signals-based traps with guest debugging enabled"
2795 );
2796 }
2797
2798 // Concurrency support is required for some component model features.
2799 let requires_concurrency = WasmFeatures::CM_ASYNC
2800 | WasmFeatures::CM_MORE_ASYNC_BUILTINS
2801 | WasmFeatures::CM_ASYNC_STACKFUL
2802 | WasmFeatures::CM_THREADING
2803 | WasmFeatures::CM_ERROR_CONTEXT;
2804 if tunables.concurrency_support && !cfg!(feature = "component-model-async") {
2805 bail!(
2806 "concurrency support was requested but was not \
2807 compiled into this build of Wasmtime"
2808 )
2809 }
2810 if !tunables.concurrency_support && features.intersects(requires_concurrency) {
2811 bail!(
2812 "concurrency support must be enabled to use the component \
2813 model async or threading features"
2814 )
2815 }
2816
2817 // Generated adapters between components will use `ref.func` in some
2818 // async-related situations so `component-model-async` requires
2819 // `reference-types`.
2820 if features.contains(WasmFeatures::CM_ASYNC)
2821 && !features.contains(WasmFeatures::REFERENCE_TYPES)
2822 {
2823 bail!("the component-model-async feature requires the wasm reference-types proposal");
2824 }
2825
2826 // If the pooling allocator is used and GC is enabled, check that
2827 // memories and the GC heap are configured identically, since the
2828 // pooling allocator can't support differently-configured heaps.
2829 #[cfg(feature = "pooling-allocator")]
2830 if matches!(
2831 &self.allocation_strategy,
2832 InstanceAllocationStrategy::Pooling(_)
2833 ) && tunables.collector.is_some()
2834 {
2835 if tunables.memory_reservation != tunables.gc_heap_reservation {
2836 bail!(
2837 "when using the pooling allocator with GC, `memory_reservation` ({}) \
2838 and `gc_heap_reservation` ({}) must be the same",
2839 tunables.memory_reservation,
2840 tunables.gc_heap_reservation,
2841 );
2842 }
2843 if tunables.memory_guard_size != tunables.gc_heap_guard_size {
2844 bail!(
2845 "when using the pooling allocator with GC, `memory_guard_size` ({}) \
2846 and `gc_heap_guard_size` ({}) must be the same",
2847 tunables.memory_guard_size,
2848 tunables.gc_heap_guard_size,
2849 );
2850 }
2851 if tunables.memory_reservation_for_growth != tunables.gc_heap_reservation_for_growth {
2852 bail!(
2853 "when using the pooling allocator with GC, \
2854 `memory_reservation_for_growth` ({}) and \
2855 `gc_heap_reservation_for_growth` ({}) must be the same",
2856 tunables.memory_reservation_for_growth,
2857 tunables.gc_heap_reservation_for_growth,
2858 );
2859 }
2860 if tunables.memory_may_move != tunables.gc_heap_may_move {
2861 bail!(
2862 "when using the pooling allocator with GC, `memory_may_move` ({}) \
2863 and `gc_heap_may_move` ({}) must be the same",
2864 tunables.memory_may_move,
2865 tunables.gc_heap_may_move,
2866 );
2867 }
2868 }
2869
2870 if tunables.debug_native && !tunables.debug_symbols {
2871 bail!("cannot enable native debug info while debug symbols are disabled");
2872 }
2873
2874 Ok((tunables, features))
2875 }
2876
2877 #[cfg(feature = "runtime")]
2878 pub(crate) fn build_allocator(
2879 &self,
2880 tunables: &Tunables,
2881 ) -> Result<Box<dyn InstanceAllocator + Send + Sync>> {
2882 let _ = tunables;
2883
2884 match &self.allocation_strategy {
2885 InstanceAllocationStrategy::OnDemand => {
2886 let mut _allocator = try_new::<Box<_>>(OnDemandInstanceAllocator::new(
2887 self.mem_creator.clone(),
2888 self.async_stack_size,
2889 self.async_stack_zeroing,
2890 ))?;
2891 #[cfg(feature = "async")]
2892 if let Some(stack_creator) = &self.stack_creator {
2893 _allocator.set_stack_creator(stack_creator.clone());
2894 }
2895 Ok(_allocator as _)
2896 }
2897 #[cfg(feature = "pooling-allocator")]
2898 InstanceAllocationStrategy::Pooling(config) => {
2899 let mut config = config.clone();
2900 let _ = &mut config;
2901 #[cfg(feature = "async")]
2902 {
2903 config.stack_size = self.async_stack_size;
2904 config.async_stack_zeroing = self.async_stack_zeroing;
2905 }
2906 let allocator = try_new::<Box<_>>(
2907 crate::runtime::vm::PoolingInstanceAllocator::new(&config, tunables)?,
2908 )?;
2909 Ok(allocator as _)
2910 }
2911 }
2912 }
2913
2914 #[cfg(feature = "runtime")]
2915 pub(crate) fn build_gc_runtime(&self) -> Result<Option<Arc<dyn GcRuntime>>> {
2916 if !self.features().gc_types() {
2917 return Ok(None);
2918 }
2919
2920 #[cfg(not(feature = "gc"))]
2921 bail!("cannot create a GC runtime: the `gc` feature was disabled at compile time");
2922
2923 #[cfg(feature = "gc")]
2924 #[cfg_attr(
2925 not(any(feature = "gc-null", feature = "gc-drc", feature = "gc-copying")),
2926 expect(unreachable_code, reason = "definitions known to be dummy")
2927 )]
2928 {
2929 Ok(Some(match self.collector.try_not_auto()? {
2930 #[cfg(feature = "gc-drc")]
2931 Collector::DeferredReferenceCounting => {
2932 try_new::<Arc<_>>(crate::runtime::vm::DrcCollector::default())? as _
2933 }
2934 #[cfg(not(feature = "gc-drc"))]
2935 Collector::DeferredReferenceCounting => unreachable!(),
2936
2937 #[cfg(feature = "gc-null")]
2938 Collector::Null => {
2939 try_new::<Arc<_>>(crate::runtime::vm::NullCollector::default())? as _
2940 }
2941 #[cfg(not(feature = "gc-null"))]
2942 Collector::Null => unreachable!(),
2943
2944 #[cfg(feature = "gc-copying")]
2945 Collector::Copying => {
2946 try_new::<Arc<_>>(crate::runtime::vm::CopyingCollector::default())? as _
2947 }
2948 #[cfg(not(feature = "gc-copying"))]
2949 Collector::Copying => unreachable!(),
2950
2951 Collector::Auto => unreachable!(),
2952 }))
2953 }
2954 }
2955
2956 #[cfg(feature = "runtime")]
2957 pub(crate) fn build_profiler(&self) -> Result<Box<dyn ProfilingAgent>> {
2958 Ok(match self.profiling_strategy {
2959 ProfilingStrategy::PerfMap => profiling_agent::new_perfmap()?,
2960 ProfilingStrategy::JitDump => profiling_agent::new_jitdump()?,
2961 ProfilingStrategy::VTune => profiling_agent::new_vtune()?,
2962 ProfilingStrategy::None => profiling_agent::new_null(),
2963 ProfilingStrategy::Pulley => profiling_agent::new_pulley()?,
2964 })
2965 }
2966
2967 #[cfg(any(feature = "cranelift", feature = "winch"))]
2968 pub(crate) fn build_compiler(
2969 mut self,
2970 tunables: &mut Tunables,
2971 features: WasmFeatures,
2972 ) -> Result<(Self, Box<dyn wasmtime_environ::Compiler>)> {
2973 let target = self.compiler_target();
2974
2975 // The target passed to the builders below is an `Option<Triple>` where
2976 // `None` represents the current host with CPU features inferred from
2977 // the host's CPU itself. The `target` above is not an `Option`, so
2978 // switch it to `None` in the case that a target wasn't explicitly
2979 // specified (which indicates no feature inference) and the target
2980 // matches the host.
2981 let target_for_builder =
2982 if self.target.is_none() && target == target_lexicon::Triple::host() {
2983 None
2984 } else {
2985 Some(target.clone())
2986 };
2987
2988 let mut compiler = match self.compiler_config_mut().strategy {
2989 #[cfg(feature = "cranelift")]
2990 Some(Strategy::Cranelift) => wasmtime_cranelift::builder(target_for_builder)?,
2991 #[cfg(not(feature = "cranelift"))]
2992 Some(Strategy::Cranelift) => bail!("cranelift support not compiled in"),
2993 #[cfg(feature = "winch")]
2994 Some(Strategy::Winch) => wasmtime_winch::builder(target_for_builder)?,
2995 #[cfg(not(feature = "winch"))]
2996 Some(Strategy::Winch) => bail!("winch support not compiled in"),
2997
2998 None | Some(Strategy::Auto) => unreachable!(),
2999 };
3000
3001 if let Some(path) = &self.compiler_config_mut().clif_dir {
3002 compiler.clif_dir(path)?;
3003 }
3004
3005 // If probestack is enabled for a target, Wasmtime will always use the
3006 // inline strategy which doesn't require us to define a `__probestack`
3007 // function or similar.
3008 self.compiler_config_mut().settings.insert(
3009 "probestack_strategy".into(),
3010 ("inline".into(), UserSpecified::No),
3011 );
3012
3013 // We enable stack probing by default on all targets.
3014 // This is required on Windows because of the way Windows
3015 // commits its stacks, but it's also a good idea on other
3016 // platforms to ensure guard pages are hit for large frame
3017 // sizes.
3018 self.compiler_config_mut()
3019 .flags
3020 .insert("enable_probestack".into(), UserSpecified::No);
3021
3022 // The current wasm multivalue implementation depends on this.
3023 // FIXME(#9510) handle this in wasmtime-cranelift instead.
3024 self.compiler_config_mut()
3025 .flags
3026 .insert("enable_multi_ret_implicit_sret".into(), UserSpecified::No);
3027
3028 if let Some(unwind_requested) = self.native_unwind_info {
3029 if !self
3030 .compiler_config_mut()
3031 .ensure_setting_unset_or_given("unwind_info", &unwind_requested.to_string())
3032 {
3033 bail!(
3034 "incompatible settings requested for Cranelift and Wasmtime `unwind-info` settings"
3035 );
3036 }
3037 }
3038
3039 if target.operating_system == target_lexicon::OperatingSystem::Windows {
3040 if !self
3041 .compiler_config_mut()
3042 .ensure_setting_unset_or_given("unwind_info", "true")
3043 {
3044 bail!("`native_unwind_info` cannot be disabled on Windows");
3045 }
3046 }
3047
3048 // We require frame pointers for correct stack walking, which is safety
3049 // critical in the presence of reference types, and otherwise it is just
3050 // really bad developer experience to get wrong.
3051 self.compiler_config_mut().settings.insert(
3052 "preserve_frame_pointers".into(),
3053 ("true".into(), UserSpecified::No),
3054 );
3055
3056 if !tunables.signals_based_traps {
3057 let mut ok = self
3058 .compiler_config_mut()
3059 .ensure_setting_unset_or_given("enable_table_access_spectre_mitigation", "false");
3060 ok = ok
3061 && self.compiler_config_mut().ensure_setting_unset_or_given(
3062 "enable_heap_access_spectre_mitigation",
3063 "false",
3064 );
3065
3066 // Right now spectre-mitigated bounds checks will load from zero so
3067 // if host-based signal handlers are disabled then that's a mismatch
3068 // and doesn't work right now. Fixing this will require more thought
3069 // of how to implement the bounds check in spectre-only mode.
3070 if !ok {
3071 bail!(
3072 "when signals-based traps are disabled then spectre \
3073 mitigations must also be disabled"
3074 );
3075 }
3076 }
3077
3078 if features.contains(WasmFeatures::RELAXED_SIMD) && !features.contains(WasmFeatures::SIMD) {
3079 bail!("cannot disable the simd proposal but enable the relaxed simd proposal");
3080 }
3081
3082 if features.contains(WasmFeatures::STACK_SWITCHING) {
3083 use target_lexicon::OperatingSystem;
3084 let model = match target.operating_system {
3085 OperatingSystem::Windows => "update_windows_tib",
3086 OperatingSystem::Linux
3087 | OperatingSystem::MacOSX(_)
3088 | OperatingSystem::Darwin(_) => "basic",
3089 _ => bail!("stack-switching feature not supported on this platform "),
3090 };
3091
3092 if !self
3093 .compiler_config_mut()
3094 .ensure_setting_unset_or_given("stack_switch_model", model)
3095 {
3096 bail!(
3097 "compiler option 'stack_switch_model' must be set to '{model}' on this platform"
3098 );
3099 }
3100 }
3101
3102 // Apply compiler settings and flags
3103 compiler.set_tunables(tunables.clone())?;
3104 for (k, (v, _)) in self.compiler_config_mut().settings.iter() {
3105 compiler.set(k, v)?;
3106 }
3107 for (flag, _) in self.compiler_config_mut().flags.iter() {
3108 compiler.enable(flag)?;
3109 }
3110 *tunables = compiler.tunables().cloned().unwrap();
3111
3112 #[cfg(all(feature = "incremental-cache", feature = "cranelift"))]
3113 if let Some(cache_store) = &self.compiler_config_mut().cache_store {
3114 compiler.enable_incremental_compilation(cache_store.clone())?;
3115 }
3116
3117 compiler.wmemcheck(self.compiler_config_mut().wmemcheck);
3118
3119 Ok((self, compiler.build()?))
3120 }
3121
3122 /// Internal setting for whether adapter modules for components will have
3123 /// extra WebAssembly instructions inserted performing more debug checks
3124 /// then are necessary.
3125 #[cfg(feature = "component-model")]
3126 pub fn debug_adapter_modules(&mut self, debug: bool) -> &mut Self {
3127 self.tunables.debug_adapter_modules = Some(debug);
3128 self
3129 }
3130
3131 /// Enables clif output when compiling a WebAssembly module.
3132 #[cfg(any(feature = "cranelift", feature = "winch"))]
3133 pub fn emit_clif(&mut self, path: &Path) -> &mut Self {
3134 self.compiler_config_mut().clif_dir = Some(path.to_path_buf());
3135 self
3136 }
3137
3138 /// Configures whether, when on macOS, Mach ports are used for exception
3139 /// handling instead of traditional Unix-based signal handling.
3140 ///
3141 /// WebAssembly traps in Wasmtime are implemented with native faults, for
3142 /// example a `SIGSEGV` will occur when a WebAssembly guest accesses
3143 /// out-of-bounds memory. Handling this can be configured to either use Unix
3144 /// signals or Mach ports on macOS. By default Mach ports are used.
3145 ///
3146 /// Mach ports enable Wasmtime to work by default with foreign
3147 /// error-handling systems such as breakpad which also use Mach ports to
3148 /// handle signals. In this situation Wasmtime will continue to handle guest
3149 /// faults gracefully while any non-guest faults will get forwarded to
3150 /// process-level handlers such as breakpad. Some more background on this
3151 /// can be found in #2456.
3152 ///
3153 /// A downside of using mach ports, however, is that they don't interact
3154 /// well with `fork()`. Forking a Wasmtime process on macOS will produce a
3155 /// child process that cannot successfully run WebAssembly. In this
3156 /// situation traditional Unix signal handling should be used as that's
3157 /// inherited and works across forks.
3158 ///
3159 /// If your embedding wants to use a custom error handler which leverages
3160 /// Mach ports and you additionally wish to `fork()` the process and use
3161 /// Wasmtime in the child process that's not currently possible. Please
3162 /// reach out to us if you're in this bucket!
3163 ///
3164 /// This option defaults to `true`, using Mach ports by default.
3165 pub fn macos_use_mach_ports(&mut self, mach_ports: bool) -> &mut Self {
3166 self.macos_use_mach_ports = mach_ports;
3167 self
3168 }
3169
3170 /// Configures an embedder-provided function, `detect`, which is used to
3171 /// determine if an ISA-specific feature is available on the current host.
3172 ///
3173 /// This function is used to verify that any features enabled for a compiler
3174 /// backend, such as AVX support on x86\_64, are also available on the host.
3175 /// It is undefined behavior to execute an AVX instruction on a host that
3176 /// doesn't support AVX instructions, for example.
3177 ///
3178 /// When the `std` feature is active on this crate then this function is
3179 /// configured to a default implementation that uses the standard library's
3180 /// feature detection. When the `std` feature is disabled then there is no
3181 /// default available and this method must be called to configure a feature
3182 /// probing function.
3183 ///
3184 /// The `detect` function provided is given a string name of an ISA feature.
3185 /// The function should then return:
3186 ///
3187 /// * `Some(true)` - indicates that the feature was found on the host and it
3188 /// is supported.
3189 /// * `Some(false)` - the feature name was recognized but it was not
3190 /// detected on the host, for example the CPU is too old.
3191 /// * `None` - the feature name was not recognized and it's not known
3192 /// whether it's on the host or not.
3193 ///
3194 /// Feature names passed to `detect` match the same feature name used in the
3195 /// Rust standard library. For example `"sse4.2"` is used on x86\_64.
3196 ///
3197 /// # Unsafety
3198 ///
3199 /// This function is `unsafe` because it is undefined behavior to execute
3200 /// instructions that a host does not support. This means that the result of
3201 /// `detect` must be correct for memory safe execution at runtime.
3202 pub unsafe fn detect_host_feature(&mut self, detect: fn(&str) -> Option<bool>) -> &mut Self {
3203 self.detect_host_feature = Some(detect);
3204 self
3205 }
3206
3207 /// Configures Wasmtime to not use signals-based trap handlers, for example
3208 /// disables `SIGILL` and `SIGSEGV` handler registration on Unix platforms.
3209 ///
3210 /// > **Note:** this option has important performance ramifications, be sure
3211 /// > to understand the implications. Wasm programs have been measured to
3212 /// > run up to 2x slower when signals-based traps are disabled.
3213 ///
3214 /// Wasmtime will by default leverage signals-based trap handlers (or the
3215 /// platform equivalent, for example "vectored exception handlers" on
3216 /// Windows) to make generated code more efficient. For example, when
3217 /// Wasmtime can use signals-based traps, it can elide explicit bounds
3218 /// checks for Wasm linear memory accesses, instead relying on virtual
3219 /// memory guard pages to raise a `SIGSEGV` (on Unix) for out-of-bounds
3220 /// accesses, which Wasmtime's runtime then catches and handles. Another
3221 /// example is divide-by-zero: with signals-based traps, Wasmtime can let
3222 /// the hardware raise a trap when the divisor is zero. Without
3223 /// signals-based traps, Wasmtime must explicitly emit additional
3224 /// instructions to check for zero and conditionally branch to a trapping
3225 /// code path.
3226 ///
3227 /// Some environments however may not have access to signal handlers. For
3228 /// example embedded scenarios may not support virtual memory. Other
3229 /// environments where Wasmtime is embedded within the surrounding
3230 /// environment may require that new signal handlers aren't registered due
3231 /// to the global nature of signal handlers. This option exists to disable
3232 /// the signal handler registration when required for these scenarios.
3233 ///
3234 /// When signals-based trap handlers are disabled, then Wasmtime and its
3235 /// generated code will *never* rely on segfaults or other
3236 /// signals. Generated code will be slower because bounds must be explicitly
3237 /// checked along with other conditions like division by zero.
3238 ///
3239 /// The following additional factors can also affect Wasmtime's ability to
3240 /// elide explicit bounds checks and leverage signals-based traps:
3241 ///
3242 /// * The [`Config::memory_reservation`] and [`Config::memory_guard_size`]
3243 /// settings
3244 /// * The index type of the linear memory (e.g. 32-bit or 64-bit)
3245 /// * The page size of the linear memory
3246 ///
3247 /// When this option is disabled, the
3248 /// `enable_heap_access_spectre_mitigation` and
3249 /// `enable_table_access_spectre_mitigation` Cranelift settings must also be
3250 /// disabled. This means that generated code must have spectre mitigations
3251 /// disabled. This is because spectre mitigations rely on faults from
3252 /// loading from the null address to implement bounds checks.
3253 ///
3254 /// This option defaults to `true`: signals-based trap handlers are enabled
3255 /// by default.
3256 ///
3257 /// > **Note:** Disabling this option is not compatible with the Winch
3258 /// > compiler.
3259 pub fn signals_based_traps(&mut self, enable: bool) -> &mut Self {
3260 self.tunables.signals_based_traps = Some(enable);
3261 self
3262 }
3263
3264 /// Enable/disable GC support in Wasmtime entirely.
3265 ///
3266 /// This flag can be used to gate whether GC infrastructure is enabled or
3267 /// initialized in Wasmtime at all. Wasmtime's GC implementation is required
3268 /// for the [`Self::wasm_gc`] proposal, [`Self::wasm_function_references`],
3269 /// and [`Self::wasm_exceptions`] at this time. None of those proposal can
3270 /// be enabled without also having this option enabled.
3271 ///
3272 /// This option defaults to whether the crate `gc` feature is enabled or
3273 /// not.
3274 pub fn gc_support(&mut self, enable: bool) -> &mut Self {
3275 self.wasm_features(WasmFeatures::GC_TYPES, enable)
3276 }
3277
3278 /// Explicitly indicate or not whether the host is using a hardware float
3279 /// ABI on x86 targets.
3280 ///
3281 /// This configuration option is only applicable on the
3282 /// `x86_64-unknown-none` Rust target and has no effect on other host
3283 /// targets. The `x86_64-unknown-none` Rust target does not support hardware
3284 /// floats by default and uses a "soft float" implementation and ABI. This
3285 /// means that `f32`, for example, is passed in a general-purpose register
3286 /// between functions instead of a floating-point register. This does not
3287 /// match Cranelift's ABI for `f32` where it's passed in floating-point
3288 /// registers. Cranelift does not have support for a "soft float"
3289 /// implementation where all floating-point operations are lowered to
3290 /// libcalls.
3291 ///
3292 /// This means that for the `x86_64-unknown-none` target the ABI between
3293 /// Wasmtime's libcalls and the host is incompatible when floats are used.
3294 /// This further means that, by default, Wasmtime is unable to load native
3295 /// code when compiled to the `x86_64-unknown-none` target. The purpose of
3296 /// this option is to explicitly allow loading code and bypass this check.
3297 ///
3298 /// Setting this configuration option to `true` indicates that either:
3299 /// (a) the Rust target is compiled with the hard-float ABI manually via
3300 /// `-Zbuild-std` and a custom target JSON configuration, or (b) sufficient
3301 /// x86 features have been enabled in the compiler such that float libcalls
3302 /// will not be used in Wasmtime. For (a) there is no way in Rust at this
3303 /// time to detect whether a hard-float or soft-float ABI is in use on
3304 /// stable Rust, so this manual opt-in is required. For (b) the only
3305 /// instance where Wasmtime passes a floating-point value in a register
3306 /// between the host and compiled wasm code is with libcalls.
3307 ///
3308 /// Float-based libcalls are only used when the compilation target for a
3309 /// wasm module has insufficient target features enabled for native
3310 /// support. For example SSE4.1 is required for the `f32.ceil` WebAssembly
3311 /// instruction to be compiled to a native instruction. If SSE4.1 is not
3312 /// enabled then `f32.ceil` is translated to a "libcall" which is
3313 /// implemented on the host. Float-based libcalls can be avoided with
3314 /// sufficient target features enabled, for example:
3315 ///
3316 /// * `self.cranelift_flag_enable("has_sse3")`
3317 /// * `self.cranelift_flag_enable("has_ssse3")`
3318 /// * `self.cranelift_flag_enable("has_sse41")`
3319 /// * `self.cranelift_flag_enable("has_sse42")`
3320 /// * `self.cranelift_flag_enable("has_fma")`
3321 ///
3322 /// Note that when these features are enabled Wasmtime will perform a
3323 /// runtime check to determine that the host actually has the feature
3324 /// present.
3325 ///
3326 /// For some more discussion see [#11506].
3327 ///
3328 /// [#11506]: https://github.com/bytecodealliance/wasmtime/issues/11506
3329 ///
3330 /// # Safety
3331 ///
3332 /// This method is not safe because it cannot be detected in Rust right now
3333 /// whether the host is compiled with a soft or hard float ABI. Additionally
3334 /// if the host is compiled with a soft float ABI disabling this check does
3335 /// not ensure that the wasm module in question has zero usage of floats
3336 /// in the boundary to the host.
3337 ///
3338 /// Safely using this method requires one of:
3339 ///
3340 /// * The host target is compiled to use hardware floats.
3341 /// * Wasm modules loaded are compiled with enough x86 Cranelift features
3342 /// enabled to avoid float-related hostcalls.
3343 pub unsafe fn x86_float_abi_ok(&mut self, enable: bool) -> &mut Self {
3344 self.x86_float_abi_ok = Some(enable);
3345 self
3346 }
3347
3348 /// Enable or disable the ability to create a
3349 /// [`SharedMemory`](crate::SharedMemory).
3350 ///
3351 /// The WebAssembly threads proposal, configured by [`Config::wasm_threads`]
3352 /// is on-by-default but there are enough deficiencies in Wasmtime's
3353 /// implementation and API integration that creation of a shared memory is
3354 /// disabled by default. This configuration knob can be used to enable this.
3355 ///
3356 /// When enabling this method be aware that wasm threads are, at this time,
3357 /// a [tier 2
3358 /// feature](https://docs.wasmtime.dev/stability-tiers.html#tier-2) in
3359 /// Wasmtime meaning that it will not receive security updates or fixes to
3360 /// historical releases. Additionally security CVEs will not be issued for
3361 /// bugs in the implementation.
3362 ///
3363 /// This option is `false` by default.
3364 pub fn shared_memory(&mut self, enable: bool) -> &mut Self {
3365 self.shared_memory = enable;
3366 self
3367 }
3368
3369 /// Specifies whether support for concurrent execution of WebAssembly is
3370 /// supported within this store.
3371 ///
3372 /// This configuration option affects whether runtime data structures are
3373 /// initialized within a `Store` on creation to support concurrent execution
3374 /// of WebAssembly guests. This is primarily applicable to the
3375 /// [`Config::wasm_component_model_async`] configuration which is the first
3376 /// time Wasmtime has supported concurrent execution of guests. This
3377 /// configuration option, for example, enables usage of
3378 /// [`Store::run_concurrent`], [`Func::call_concurrent`], [`StreamReader`],
3379 /// etc.
3380 ///
3381 /// This configuration option can be manually disabled to avoid initializing
3382 /// data structures in the [`Store`] related to concurrent execution. When
3383 /// this option is disabled then APIs related to concurrency will all fail
3384 /// with a panic. For example [`Store::run_concurrent`] will panic, creating
3385 /// a [`StreamReader`] will panic, etc.
3386 ///
3387 /// The value of this option additionally affects whether a [`Config`] is
3388 /// valid and the default set of enabled WebAssembly features. If this
3389 /// option is disabled then component-model features related to concurrency
3390 /// will all be disabled. If this option is enabled, then the options will
3391 /// retain their normal defaults. It is not valid to create a [`Config`]
3392 /// with component-model-async explicitly enabled and this option explicitly
3393 /// disabled, however.
3394 ///
3395 /// This option defaults to `true`.
3396 ///
3397 /// [`Store`]: crate::Store
3398 /// [`Store::run_concurrent`]: crate::Store::run_concurrent
3399 /// [`Func::call_concurrent`]: crate::component::Func::call_concurrent
3400 /// [`StreamReader`]: crate::component::StreamReader
3401 pub fn concurrency_support(&mut self, enable: bool) -> &mut Self {
3402 self.tunables.concurrency_support = Some(enable);
3403 self
3404 }
3405
3406 /// Validate if the current configuration has conflicting overrides that prevent
3407 /// execution determinism. Returns an error if a conflict exists.
3408 ///
3409 /// Note: Keep this in sync with [`Config::enforce_determinism`].
3410 #[inline]
3411 #[cfg(feature = "rr")]
3412 pub(crate) fn validate_rr_determinism_conflicts(&self) -> Result<()> {
3413 if let Some(v) = self.tunables.relaxed_simd_deterministic {
3414 if v == false {
3415 bail!("Relaxed deterministic SIMD cannot be disabled when determinism is enforced");
3416 }
3417 }
3418 #[cfg(any(feature = "cranelift", feature = "winch"))]
3419 if let Some((v, _)) = self
3420 .compiler_config
3421 .as_ref()
3422 .and_then(|c| c.settings.get("enable_nan_canonicalization"))
3423 {
3424 if v != "true" {
3425 bail!("NaN canonicalization cannot be disabled when determinism is enforced");
3426 }
3427 }
3428 Ok(())
3429 }
3430
3431 /// Enable execution trace recording or replaying to the configuration.
3432 ///
3433 /// When either recording/replaying are enabled, validation fails if settings
3434 /// that control determinism are not set appropriately. In particular, RR requires
3435 /// doing the following:
3436 /// * Enabling NaN canonicalization with [`Config::cranelift_nan_canonicalization`].
3437 /// * Enabling deterministic relaxed SIMD with [`Config::relaxed_simd_deterministic`].
3438 #[inline]
3439 pub fn rr(&mut self, cfg: RRConfig) -> &mut Self {
3440 self.rr_config = cfg;
3441 self
3442 }
3443
3444 /// Whether or not trap metadata is generated in compiled wasms for internal
3445 /// asserts in the compiled code itself.
3446 ///
3447 /// Wasmtime inserts metadata within compiled artifacts which contain a
3448 /// table of known trap codes for all instructions. If a trap via a signal
3449 /// happens, and it's not listed in these tables, then that's considered a
3450 /// fatal bug that crashes the process. This option controls whether trap
3451 /// codes are inserted into metadata for internal asserts as part of
3452 /// Wasmtime's translation process. These internal asserts should never be
3453 /// triggered, but if they are then the process dies with a signal.
3454 ///
3455 /// Inserting trap metadata into compiled artifacts can take extra space in
3456 /// the final artifact. The trap tables for the artifact will be larger as
3457 /// they contain more trap codes to contain.
3458 ///
3459 /// This is intended as a debugging option and is set to `false` by
3460 /// default.
3461 pub fn metadata_for_internal_asserts(&mut self, enable: bool) -> &mut Self {
3462 self.tunables.metadata_for_internal_asserts = Some(enable);
3463 self
3464 }
3465
3466 /// Whether or not trap metadata is generated in compiled wasms for
3467 /// detection of corruption in the GC heap.
3468 ///
3469 /// For more information about what metadata is in this scenario, see
3470 /// [`Config::metadata_for_internal_asserts`]. Note, though, that this
3471 /// option is enabled by default unlike internal asserts. This is intended
3472 /// as a defense-in-depth option for generated code in the face of GC heap
3473 /// corruption. If the GC heap is corrupted and is detected then the
3474 /// trapping instruction will be gracefully handled and delivered to the
3475 /// embedder. Otherwise if this option were set to `false` then the process
3476 /// would be aborted due to a signal.
3477 pub fn metadata_for_gc_heap_corruption(&mut self, enable: bool) -> &mut Self {
3478 self.tunables.metadata_for_gc_heap_corruption = Some(enable);
3479 self
3480 }
3481}
3482
3483impl Default for Config {
3484 fn default() -> Config {
3485 Config::new()
3486 }
3487}
3488
3489impl fmt::Debug for Config {
3490 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3491 let mut f = f.debug_struct("Config");
3492
3493 // Not every flag in WasmFeatures can be enabled as part of creating
3494 // a Config. This impl gives a complete picture of all WasmFeatures
3495 // enabled, and doesn't require maintenance by hand (which has become out
3496 // of date in the past), at the cost of possible confusion for why
3497 // a flag in this set doesn't have a Config setter.
3498 let features = self.features();
3499 for flag in WasmFeatures::FLAGS.iter() {
3500 f.field(
3501 &format!("wasm_{}", flag.name().to_lowercase()),
3502 &features.contains(*flag.value()),
3503 );
3504 }
3505
3506 f.field("parallel_compilation", &self.parallel_compilation);
3507 #[cfg(any(feature = "cranelift", feature = "winch"))]
3508 {
3509 f.field("compiler_config", &self.compiler_config);
3510 }
3511
3512 self.tunables.format(&mut f);
3513 f.finish()
3514 }
3515}
3516
3517/// Possible Compilation strategies for a wasm module.
3518///
3519/// This is used as an argument to the [`Config::strategy`] method.
3520#[non_exhaustive]
3521#[derive(PartialEq, Eq, Clone, Debug, Copy)]
3522pub enum Strategy {
3523 /// An indicator that the compilation strategy should be automatically
3524 /// selected.
3525 ///
3526 /// This is generally what you want for most projects and indicates that the
3527 /// `wasmtime` crate itself should make the decision about what the best
3528 /// code generator for a wasm module is.
3529 ///
3530 /// Currently this always defaults to Cranelift, but the default value may
3531 /// change over time.
3532 Auto,
3533
3534 /// Currently the default backend, Cranelift aims to be a reasonably fast
3535 /// code generator which generates high quality machine code.
3536 Cranelift,
3537
3538 /// A low-latency baseline compiler for WebAssembly.
3539 /// For more details regarding ISA support and Wasm proposals support
3540 /// see <https://docs.wasmtime.dev/stability-tiers.html#current-tier-status>
3541 Winch,
3542}
3543
3544#[cfg(any(feature = "winch", feature = "cranelift"))]
3545impl Strategy {
3546 fn not_auto(&self) -> Option<Strategy> {
3547 match self {
3548 Strategy::Auto => {
3549 if cfg!(feature = "cranelift") {
3550 Some(Strategy::Cranelift)
3551 } else if cfg!(feature = "winch") {
3552 Some(Strategy::Winch)
3553 } else {
3554 None
3555 }
3556 }
3557 other => Some(*other),
3558 }
3559 }
3560}
3561
3562/// Possible garbage collector implementations for Wasm.
3563///
3564/// This is used as an argument to the [`Config::collector`] method.
3565///
3566/// The properties of Wasmtime's available collectors are summarized in the
3567/// following table:
3568///
3569/// | Collector | Collects Garbage[^1] | Latency[^2] | Throughput[^3] | Allocation Speed[^4] | Heap Utilization[^5] |
3570/// |-----------------------------|-----------------------|-------------|----------------|----------------------|----------------------|
3571/// | `Copying` | Yes, including cycles | 🙁 | 🙂 | 🙂 | 🙁 |
3572/// | `DeferredReferenceCounting` | Yes, but not cycles | 🙂 | 🙁 | 😐 | 😐 |
3573/// | `Null` | No | 🙂 | 🙂 | 🙂 | 🙂 |
3574///
3575/// [^1]: Whether or not the collector is capable of collecting garbage and cyclic garbage.
3576///
3577/// [^2]: How long the Wasm program is paused during garbage
3578/// collections. Shorter is better. In general, better latency implies
3579/// worse throughput and vice versa.
3580///
3581/// [^3]: How fast the Wasm program runs when using this collector. Roughly
3582/// equivalent to the number of Wasm instructions executed per
3583/// second. Faster is better. In general, better throughput implies worse
3584/// latency and vice versa.
3585///
3586/// [^4]: How fast can individual objects be allocated?
3587///
3588/// [^5]: How many objects can the collector fit into N bytes of memory? That
3589/// is, how much space for bookkeeping and metadata does this collector
3590/// require? Less space taken up by metadata means more space for
3591/// additional objects. Reference counts are larger than mark bits and
3592/// free lists are larger than bump pointers, for example.
3593#[non_exhaustive]
3594#[derive(PartialEq, Eq, Clone, Debug, Copy)]
3595pub enum Collector {
3596 /// An indicator that the garbage collector should be automatically
3597 /// selected.
3598 ///
3599 /// This is generally what you want for most projects and indicates that the
3600 /// `wasmtime` crate itself should make the decision about what the best
3601 /// collector to use is.
3602 ///
3603 /// Currently this always defaults to the copying collector, but the default
3604 /// value may change over time.
3605 Auto,
3606
3607 /// The deferred reference-counting collector.
3608 ///
3609 /// A reference-counting collector, generally trading improved latency for
3610 /// worsened throughput. However, to avoid the largest overheads of
3611 /// reference counting, it avoids manipulating reference counts for Wasm
3612 /// objects on the stack. Instead, it will hold a reference count for an
3613 /// over-approximation of all objects that are currently on the stack, trace
3614 /// the stack during collection to find the precise set of on-stack roots,
3615 /// and decrement the reference count of any object that was in the
3616 /// over-approximation but not the precise set. This improves throughput,
3617 /// compared to "pure" reference counting, by performing many fewer
3618 /// refcount-increment and -decrement operations. The cost is the increased
3619 /// latency associated with tracing the stack.
3620 ///
3621 /// This collector cannot currently collect cycles; they will leak until the
3622 /// GC heap's store is dropped.
3623 DeferredReferenceCounting,
3624
3625 /// The null collector.
3626 ///
3627 /// This collector does not actually collect any garbage. It simply
3628 /// allocates objects until it runs out of memory, at which point further
3629 /// objects allocation attempts will trap.
3630 ///
3631 /// This collector is useful for incredibly short-running Wasm instances
3632 /// where additionally you would rather halt an over-allocating Wasm program
3633 /// than spend time collecting its garbage to allow it to keep running. It
3634 /// is also useful for measuring the overheads associated with other
3635 /// collectors, as this collector imposes as close to zero throughput and
3636 /// latency overhead as possible.
3637 Null,
3638
3639 /// The copying collector.
3640 ///
3641 /// A tracing collector that splits the GC heap in half, bump-allocates
3642 /// objects in one half until it fills up, and then does a GC and copies
3643 /// live objects into the other half, and repeats the process. It has fast
3644 /// allocation, collects cyclic garbage, and good collection throughput,
3645 /// however it suffers from poor latency due to its stop-the-world
3646 /// collections and poor heap utilization due to only using half the GC
3647 /// heap's full capacity at any given time.
3648 ///
3649 /// Note that this collector is still under construction and is not yet
3650 /// functional.
3651 Copying,
3652}
3653
3654impl Default for Collector {
3655 fn default() -> Collector {
3656 Collector::Auto
3657 }
3658}
3659
3660#[cfg(feature = "gc")]
3661impl Collector {
3662 fn not_auto(&self) -> Option<Collector> {
3663 match self {
3664 Collector::Auto => {
3665 if cfg!(feature = "gc-copying") {
3666 Some(Collector::Copying)
3667 } else if cfg!(feature = "gc-drc") {
3668 Some(Collector::DeferredReferenceCounting)
3669 } else if cfg!(feature = "gc-null") {
3670 Some(Collector::Null)
3671 } else {
3672 None
3673 }
3674 }
3675 other => Some(*other),
3676 }
3677 }
3678
3679 fn try_not_auto(&self) -> Result<Self> {
3680 match self.not_auto() {
3681 #[cfg(feature = "gc-drc")]
3682 Some(c @ Collector::DeferredReferenceCounting) => Ok(c),
3683 #[cfg(not(feature = "gc-drc"))]
3684 Some(Collector::DeferredReferenceCounting) => bail!(
3685 "cannot create an engine using the deferred reference-counting \
3686 collector because the `gc-drc` feature was not enabled at \
3687 compile time",
3688 ),
3689
3690 #[cfg(feature = "gc-null")]
3691 Some(c @ Collector::Null) => Ok(c),
3692 #[cfg(not(feature = "gc-null"))]
3693 Some(Collector::Null) => bail!(
3694 "cannot create an engine using the null collector because \
3695 the `gc-null` feature was not enabled at compile time",
3696 ),
3697
3698 #[cfg(feature = "gc-copying")]
3699 Some(c @ Collector::Copying) => Ok(c),
3700 #[cfg(not(feature = "gc-copying"))]
3701 Some(Collector::Copying) => bail!(
3702 "cannot create an engine using the copying collector because \
3703 the `gc-copying` feature was not enabled at compile time",
3704 ),
3705
3706 Some(Collector::Auto) => unreachable!(),
3707
3708 None => bail!(
3709 "cannot create an engine with GC support when none of the \
3710 collectors are available; enable one of the following \
3711 features: `gc-drc`, `gc-null`, `gc-copying`",
3712 ),
3713 }
3714 }
3715}
3716
3717/// Possible optimization levels for the Cranelift codegen backend.
3718#[non_exhaustive]
3719#[derive(Copy, Clone, Debug, Eq, PartialEq)]
3720pub enum OptLevel {
3721 /// No optimizations performed, minimizes compilation time by disabling most
3722 /// optimizations.
3723 None,
3724 /// Generates the fastest possible code, but may take longer.
3725 Speed,
3726 /// Similar to `speed`, but also performs transformations aimed at reducing
3727 /// code size.
3728 SpeedAndSize,
3729}
3730
3731/// Possible register allocator algorithms for the Cranelift codegen backend.
3732#[non_exhaustive]
3733#[derive(Copy, Clone, Debug, Eq, PartialEq)]
3734pub enum RegallocAlgorithm {
3735 /// Generates the fastest possible code, but may take longer.
3736 ///
3737 /// This algorithm performs "backtracking", which means that it may
3738 /// undo its earlier work and retry as it discovers conflicts. This
3739 /// results in better register utilization, producing fewer spills
3740 /// and moves, but can cause super-linear compile runtime.
3741 Backtracking,
3742 /// Generates acceptable code very quickly.
3743 ///
3744 /// This algorithm performs a single pass through the code,
3745 /// guaranteed to work in linear time. (Note that the rest of
3746 /// Cranelift is not necessarily guaranteed to run in linear time,
3747 /// however.) It cannot undo earlier decisions, however, and it
3748 /// cannot foresee constraints or issues that may occur further
3749 /// ahead in the code, so the code may have more spills and moves as
3750 /// a result.
3751 ///
3752 /// > **Note**: This algorithm is not yet production-ready and has
3753 /// > historically had known problems. It is not recommended to enable this
3754 /// > algorithm for security-sensitive applications and the Wasmtime project
3755 /// > does not consider this configuration option for issuing security
3756 /// > advisories at this time.
3757 SinglePass,
3758}
3759
3760/// Select which profiling technique to support.
3761#[derive(Debug, Clone, Copy, PartialEq)]
3762pub enum ProfilingStrategy {
3763 /// No profiler support.
3764 None,
3765
3766 /// Collect function name information as the "perf map" file format, used with `perf` on Linux.
3767 PerfMap,
3768
3769 /// Collect profiling info for "jitdump" file format, used with `perf` on
3770 /// Linux.
3771 JitDump,
3772
3773 /// Collect profiling info using the "ittapi", used with `VTune` on Linux.
3774 VTune,
3775
3776 /// Support for profiling Pulley, Wasmtime's interpreter. Note that enabling
3777 /// this at runtime requires enabling the `profile-pulley` Cargo feature at
3778 /// compile time.
3779 Pulley,
3780}
3781
3782/// Select how wasm backtrace detailed information is handled.
3783#[derive(Debug, Clone, Copy)]
3784pub enum WasmBacktraceDetails {
3785 /// Support is unconditionally enabled and wasmtime will parse and read
3786 /// debug information.
3787 Enable,
3788
3789 /// Support is disabled, and wasmtime will not parse debug information for
3790 /// backtrace details.
3791 Disable,
3792
3793 /// Support for backtrace details is conditional on the
3794 /// `WASMTIME_BACKTRACE_DETAILS` environment variable.
3795 Environment,
3796}
3797
3798/// Describe the tri-state configuration of keys such as MPK or PAGEMAP_SCAN.
3799#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
3800pub enum Enabled {
3801 /// Enable this feature if it's detected on the host system, otherwise leave
3802 /// it disabled.
3803 Auto,
3804 /// Enable this feature and fail configuration if the feature is not
3805 /// detected on the host system.
3806 Yes,
3807 /// Do not enable this feature, even if the host system supports it.
3808 No,
3809}
3810
3811/// Configuration options used with [`InstanceAllocationStrategy::Pooling`] to
3812/// change the behavior of the pooling instance allocator.
3813///
3814/// This structure has a builder-style API in the same manner as [`Config`] and
3815/// is configured with [`Config::allocation_strategy`].
3816///
3817/// Note that usage of the pooling allocator does not affect compiled
3818/// WebAssembly code. Compiled `*.cwasm` files, for example, are usable both
3819/// with and without the pooling allocator.
3820///
3821/// ## Advantages of Pooled Allocation
3822///
3823/// The main benefit of the pooling allocator is to make WebAssembly
3824/// instantiation both faster and more scalable in terms of parallelism.
3825/// Allocation is faster because virtual memory is already configured and ready
3826/// to go within the pool, there's no need to [`mmap`] (for example on Unix) a
3827/// new region and configure it with guard pages. By avoiding [`mmap`] this
3828/// avoids whole-process virtual memory locks which can improve scalability and
3829/// performance through avoiding this.
3830///
3831/// Additionally with pooled allocation it's possible to create "affine slots"
3832/// to a particular WebAssembly module or component over time. For example if
3833/// the same module is multiple times over time the pooling allocator will, by
3834/// default, attempt to reuse the same slot. This mean that the slot has been
3835/// pre-configured and can retain virtual memory mappings for a copy-on-write
3836/// image, for example (see [`Config::memory_init_cow`] for more information.
3837/// This means that in a steady state instance deallocation is a single
3838/// [`madvise`] to reset linear memory to its original contents followed by a
3839/// single (optional) [`mprotect`] during the next instantiation to shrink
3840/// memory back to its original size. Compared to non-pooled allocation this
3841/// avoids the need to [`mmap`] a new region of memory, [`munmap`] it, and
3842/// [`mprotect`] regions too.
3843///
3844/// Another benefit of pooled allocation is that it's possible to configure
3845/// things such that no virtual memory management is required at all in a steady
3846/// state. For example a pooling allocator can be configured with:
3847///
3848/// * [`Config::memory_init_cow`] disabled
3849/// * [`Config::memory_guard_size`] disabled
3850/// * [`Config::memory_reservation`] shrunk to minimal size
3851/// * [`PoolingAllocationConfig::table_keep_resident`] sufficiently large
3852/// * [`PoolingAllocationConfig::linear_memory_keep_resident`] sufficiently large
3853///
3854/// With all these options in place no virtual memory tricks are used at all and
3855/// everything is manually managed by Wasmtime (for example resetting memory is
3856/// a `memset(0)`). This is not as fast in a single-threaded scenario but can
3857/// provide benefits in high-parallelism situations as no virtual memory locks
3858/// or IPIs need happen.
3859///
3860/// ## Disadvantages of Pooled Allocation
3861///
3862/// Despite the above advantages to instantiation performance the pooling
3863/// allocator is not enabled by default in Wasmtime. One reason is that the
3864/// performance advantages are not necessarily portable, for example while the
3865/// pooling allocator works on Windows it has not been tuned for performance on
3866/// Windows in the same way it has on Linux.
3867///
3868/// Additionally the main cost of the pooling allocator is that it requires a
3869/// very large reservation of virtual memory (on the order of most of the
3870/// addressable virtual address space). WebAssembly 32-bit linear memories in
3871/// Wasmtime are, by default 4G address space reservations with a small guard
3872/// region both before and after the linear memory. Memories in the pooling
3873/// allocator are contiguous which means that we only need a guard after linear
3874/// memory because the previous linear memory's slot post-guard is our own
3875/// pre-guard. This means that, by default, the pooling allocator uses roughly
3876/// 4G of virtual memory per WebAssembly linear memory slot. 4G of virtual
3877/// memory is 32 bits of a 64-bit address. Many 64-bit systems can only
3878/// actually use 48-bit addresses by default (although this can be extended on
3879/// architectures nowadays too), and of those 48 bits one of them is reserved
3880/// to indicate kernel-vs-userspace. This leaves 47-32=15 bits left,
3881/// meaning you can only have at most 32k slots of linear memories on many
3882/// systems by default. This is a relatively small number and shows how the
3883/// pooling allocator can quickly exhaust all of virtual memory.
3884///
3885/// Another disadvantage of the pooling allocator is that it may keep memory
3886/// alive when nothing is using it. A previously used slot for an instance might
3887/// have paged-in memory that will not get paged out until the
3888/// [`Engine`] owning the pooling allocator is dropped. While
3889/// suitable for some applications this behavior may not be suitable for all
3890/// applications.
3891///
3892/// Finally the last disadvantage of the pooling allocator is that the
3893/// configuration values for the maximum number of instances, memories, tables,
3894/// etc, must all be fixed up-front. There's not always a clear answer as to
3895/// what these values should be so not all applications may be able to work
3896/// with this constraint.
3897///
3898/// [`madvise`]: https://man7.org/linux/man-pages/man2/madvise.2.html
3899/// [`mprotect`]: https://man7.org/linux/man-pages/man2/mprotect.2.html
3900/// [`mmap`]: https://man7.org/linux/man-pages/man2/mmap.2.html
3901/// [`munmap`]: https://man7.org/linux/man-pages/man2/munmap.2.html
3902#[derive(Debug, Clone)]
3903pub struct PoolingAllocationConfig {
3904 /// See `PoolingAllocatorConfig::max_unused_warm_slots` in `wasmtime`
3905 pub(crate) max_unused_warm_slots: u32,
3906 /// The target number of decommits to do per batch. This is not precise, as
3907 /// we can queue up decommits at times when we aren't prepared to
3908 /// immediately flush them, and so we may go over this target size
3909 /// occasionally.
3910 pub(crate) decommit_batch_size: usize,
3911 /// The size, in bytes, of async stacks to allocate (not including the guard
3912 /// page).
3913 #[cfg_attr(
3914 not(all(feature = "async", feature = "pooling-allocator")),
3915 expect(dead_code, reason = "easier to cfg")
3916 )]
3917 pub(crate) stack_size: usize,
3918 /// The limits to apply to instances allocated within this allocator.
3919 pub(crate) limits: InstanceLimits,
3920 /// Whether or not async stacks are zeroed after use.
3921 #[cfg_attr(
3922 not(all(feature = "async", feature = "pooling-allocator")),
3923 expect(dead_code, reason = "easier to cfg")
3924 )]
3925 pub(crate) async_stack_zeroing: bool,
3926 /// If async stack zeroing is enabled and the host platform is Linux this is
3927 /// how much memory to zero out with `memset`.
3928 ///
3929 /// The rest of memory will be zeroed out with `madvise`.
3930 pub(crate) async_stack_keep_resident: usize,
3931 /// How much linear memory, in bytes, to keep resident after resetting for
3932 /// use with the next instance. This much memory will be `memset` to zero
3933 /// when a linear memory is deallocated.
3934 ///
3935 /// Memory exceeding this amount in the wasm linear memory will be released
3936 /// with `madvise` back to the kernel.
3937 ///
3938 /// Only applicable on Linux.
3939 pub(crate) linear_memory_keep_resident: usize,
3940 /// Same as `linear_memory_keep_resident` but for tables.
3941 pub(crate) table_keep_resident: usize,
3942 /// Whether to enable memory protection keys.
3943 pub(crate) memory_protection_keys: Enabled,
3944 /// How many memory protection keys to allocate.
3945 pub(crate) max_memory_protection_keys: usize,
3946 /// Whether to enable PAGEMAP_SCAN on Linux.
3947 pub(crate) pagemap_scan: Enabled,
3948}
3949
3950impl Default for PoolingAllocationConfig {
3951 fn default() -> Self {
3952 Self {
3953 max_unused_warm_slots: 100,
3954 decommit_batch_size: 1,
3955 stack_size: 2 << 20,
3956 limits: InstanceLimits::default(),
3957 async_stack_zeroing: false,
3958 async_stack_keep_resident: 0,
3959 linear_memory_keep_resident: 0,
3960 table_keep_resident: 0,
3961 memory_protection_keys: Enabled::No,
3962 max_memory_protection_keys: 16,
3963 pagemap_scan: Enabled::No,
3964 }
3965 }
3966}
3967
3968/// Instance-related limit configuration for pooling.
3969///
3970/// More docs on this can be found at `wasmtime::PoolingAllocationConfig`.
3971#[derive(Debug, Copy, Clone)]
3972pub(crate) struct InstanceLimits {
3973 /// The maximum number of component instances that may be allocated
3974 /// concurrently.
3975 pub(crate) total_component_instances: u32,
3976
3977 /// The maximum size of a component's `VMComponentContext`, including
3978 /// the aggregate size of all its inner core modules' `VMContext` sizes.
3979 pub(crate) component_instance_size: usize,
3980
3981 /// The maximum number of core module instances that may be allocated
3982 /// concurrently.
3983 pub(crate) total_core_instances: u32,
3984
3985 /// The maximum number of core module instances that a single component may
3986 /// transitively contain.
3987 pub(crate) max_core_instances_per_component: u32,
3988
3989 /// The maximum number of Wasm linear memories that a component may
3990 /// transitively contain.
3991 pub(crate) max_memories_per_component: u32,
3992
3993 /// The maximum number of tables that a component may transitively contain.
3994 pub(crate) max_tables_per_component: u32,
3995
3996 /// The total number of linear memories in the pool, across all instances.
3997 pub(crate) total_memories: u32,
3998
3999 /// The total number of tables in the pool, across all instances.
4000 pub(crate) total_tables: u32,
4001
4002 /// The total number of async stacks in the pool, across all instances.
4003 pub(crate) total_stacks: u32,
4004
4005 /// Maximum size of a core instance's `VMContext`.
4006 pub(crate) core_instance_size: usize,
4007
4008 /// Maximum number of tables per instance.
4009 pub(crate) max_tables_per_module: u32,
4010
4011 /// Maximum number of word-size elements per table.
4012 ///
4013 /// Note that tables for element types such as continuations
4014 /// that use more than one word of storage may store fewer
4015 /// elements.
4016 pub(crate) table_elements: usize,
4017
4018 /// Maximum number of linear memories per instance.
4019 pub(crate) max_memories_per_module: u32,
4020
4021 /// Maximum byte size of a linear memory, must be smaller than
4022 /// `memory_reservation` in `Tunables`.
4023 pub(crate) max_memory_size: usize,
4024
4025 /// The total number of GC heaps in the pool, across all instances.
4026 pub(crate) total_gc_heaps: u32,
4027}
4028
4029impl Default for InstanceLimits {
4030 fn default() -> Self {
4031 let total = if cfg!(target_pointer_width = "32") {
4032 100
4033 } else {
4034 1000
4035 };
4036 // See doc comments for `wasmtime::PoolingAllocationConfig` for these
4037 // default values
4038 Self {
4039 total_component_instances: total,
4040 component_instance_size: 1 << 20, // 1 MiB
4041 total_core_instances: total,
4042 max_core_instances_per_component: u32::MAX,
4043 max_memories_per_component: u32::MAX,
4044 max_tables_per_component: u32::MAX,
4045 total_memories: total,
4046 total_tables: total,
4047 total_stacks: total,
4048 core_instance_size: 1 << 20, // 1 MiB
4049 max_tables_per_module: 1,
4050 // NB: in #8504 it was seen that a C# module in debug module can
4051 // have 10k+ elements.
4052 table_elements: 20_000,
4053 max_memories_per_module: 1,
4054 #[cfg(target_pointer_width = "64")]
4055 max_memory_size: 1 << 32, // 4G,
4056 #[cfg(target_pointer_width = "32")]
4057 max_memory_size: 10 << 20, // 10 MiB
4058 total_gc_heaps: total,
4059 }
4060 }
4061}
4062
4063impl PoolingAllocationConfig {
4064 /// Returns a new configuration builder with all default settings
4065 /// configured.
4066 pub fn new() -> PoolingAllocationConfig {
4067 PoolingAllocationConfig::default()
4068 }
4069
4070 /// Configures the maximum number of "unused warm slots" to retain in the
4071 /// pooling allocator.
4072 ///
4073 /// The pooling allocator operates over slots to allocate from, and each
4074 /// slot is considered "cold" if it's never been used before or "warm" if
4075 /// it's been used by some module in the past. Slots in the pooling
4076 /// allocator additionally track an "affinity" flag to a particular core
4077 /// wasm module. When a module is instantiated into a slot then the slot is
4078 /// considered affine to that module, even after the instance has been
4079 /// deallocated.
4080 ///
4081 /// When a new instance is created then a slot must be chosen, and the
4082 /// current algorithm for selecting a slot is:
4083 ///
4084 /// * If there are slots that are affine to the module being instantiated,
4085 /// then the most recently used slot is selected to be allocated from.
4086 /// This is done to improve reuse of resources such as memory mappings and
4087 /// additionally try to benefit from temporal locality for things like
4088 /// caches.
4089 ///
4090 /// * Otherwise if there are more than N affine slots to other modules, then
4091 /// one of those affine slots is chosen to be allocated. The slot chosen
4092 /// is picked on a least-recently-used basis.
4093 ///
4094 /// * Finally, if there are less than N affine slots to other modules, then
4095 /// the non-affine slots are allocated from.
4096 ///
4097 /// This setting, `max_unused_warm_slots`, is the value for N in the above
4098 /// algorithm. The purpose of this setting is to have a knob over the RSS
4099 /// impact of "unused slots" for a long-running wasm server.
4100 ///
4101 /// If this setting is set to 0, for example, then affine slots are
4102 /// aggressively reused on a least-recently-used basis. A "cold" slot is
4103 /// only used if there are no affine slots available to allocate from. This
4104 /// means that the set of slots used over the lifetime of a program is the
4105 /// same as the maximum concurrent number of wasm instances.
4106 ///
4107 /// If this setting is set to infinity, however, then cold slots are
4108 /// prioritized to be allocated from. This means that the set of slots used
4109 /// over the lifetime of a program will approach
4110 /// [`PoolingAllocationConfig::total_memories`], or the maximum number of
4111 /// slots in the pooling allocator.
4112 ///
4113 /// Wasmtime does not aggressively decommit all resources associated with a
4114 /// slot when the slot is not in use. For example the
4115 /// [`PoolingAllocationConfig::linear_memory_keep_resident`] option can be
4116 /// used to keep memory associated with a slot, even when it's not in use.
4117 /// This means that the total set of used slots in the pooling instance
4118 /// allocator can impact the overall RSS usage of a program.
4119 ///
4120 /// The default value for this option is `100`.
4121 pub fn max_unused_warm_slots(&mut self, max: u32) -> &mut Self {
4122 self.max_unused_warm_slots = max;
4123 self
4124 }
4125
4126 /// The target number of decommits to do per batch.
4127 ///
4128 /// This is not precise, as we can queue up decommits at times when we
4129 /// aren't prepared to immediately flush them, and so we may go over this
4130 /// target size occasionally.
4131 ///
4132 /// Note additionally that the queue of not-yet-decommitted entities is
4133 /// sharded to reduce lock contention: one shard per available CPU, capped
4134 /// at 16. Each shard batches up to this many decommits independently,
4135 /// meaning that up to `min(available_parallelism, 16) * (batch_size - 1)`
4136 /// decommits may be queued and not yet flushed at any given time.
4137 ///
4138 /// A batch size of one effectively disables batching.
4139 ///
4140 /// Defaults to `1`.
4141 pub fn decommit_batch_size(&mut self, batch_size: usize) -> &mut Self {
4142 self.decommit_batch_size = batch_size;
4143 self
4144 }
4145
4146 /// How much memory, in bytes, to keep resident for async stacks allocated
4147 /// with the pooling allocator.
4148 ///
4149 /// When [`Config::async_stack_zeroing`] is enabled then Wasmtime will reset
4150 /// the contents of async stacks back to zero upon deallocation. This option
4151 /// can be used to perform the zeroing operation with `memset` up to a
4152 /// certain threshold of bytes instead of using system calls to reset the
4153 /// stack to zero.
4154 ///
4155 /// Note that when using this option the memory with async stacks will
4156 /// never be decommitted.
4157 pub fn async_stack_keep_resident(&mut self, size: usize) -> &mut Self {
4158 self.async_stack_keep_resident = size;
4159 self
4160 }
4161
4162 /// How much memory, in bytes, to keep resident for each linear memory
4163 /// after deallocation.
4164 ///
4165 /// This option is only applicable on Linux and has no effect on other
4166 /// platforms.
4167 ///
4168 /// By default Wasmtime will use `madvise` to reset the entire contents of
4169 /// linear memory back to zero when a linear memory is deallocated. This
4170 /// option can be used to use `memset` instead to set memory back to zero
4171 /// which can, in some configurations, reduce the number of page faults
4172 /// taken when a slot is reused.
4173 pub fn linear_memory_keep_resident(&mut self, size: usize) -> &mut Self {
4174 self.linear_memory_keep_resident = size;
4175 self
4176 }
4177
4178 /// How much memory, in bytes, to keep resident for each table after
4179 /// deallocation.
4180 ///
4181 /// This option is only applicable on Linux and has no effect on other
4182 /// platforms.
4183 ///
4184 /// This option is the same as
4185 /// [`PoolingAllocationConfig::linear_memory_keep_resident`] except that it
4186 /// is applicable to tables instead.
4187 pub fn table_keep_resident(&mut self, size: usize) -> &mut Self {
4188 self.table_keep_resident = size;
4189 self
4190 }
4191
4192 /// The maximum number of concurrent component instances supported (default
4193 /// is `1000`).
4194 ///
4195 /// This provides an upper-bound on the total size of component
4196 /// metadata-related allocations, along with
4197 /// [`PoolingAllocationConfig::max_component_instance_size`]. The upper bound is
4198 ///
4199 /// ```text
4200 /// total_component_instances * max_component_instance_size
4201 /// ```
4202 ///
4203 /// where `max_component_instance_size` is rounded up to the size and alignment
4204 /// of the internal representation of the metadata.
4205 pub fn total_component_instances(&mut self, count: u32) -> &mut Self {
4206 self.limits.total_component_instances = count;
4207 self
4208 }
4209
4210 /// The maximum size, in bytes, allocated for a component instance's
4211 /// `VMComponentContext` metadata as well as the aggregate size of this
4212 /// component's core instances `VMContext` metadata.
4213 ///
4214 /// The [`wasmtime::component::Instance`][crate::component::Instance] type
4215 /// has a static size but its internal `VMComponentContext` is dynamically
4216 /// sized depending on the component being instantiated. This size limit
4217 /// loosely correlates to the size of the component, taking into account
4218 /// factors such as:
4219 ///
4220 /// * number of lifted and lowered functions,
4221 /// * number of memories
4222 /// * number of inner instances
4223 /// * number of resources
4224 ///
4225 /// If the allocated size per instance is too small then instantiation of a
4226 /// module will fail at runtime with an error indicating how many bytes were
4227 /// needed.
4228 ///
4229 /// In addition to the memory in the runtime for the component itself,
4230 /// components contain one or more core module instances. Each of these
4231 /// require some memory in the runtime as described in
4232 /// [`PoolingAllocationConfig::max_core_instance_size`]. The limit here
4233 /// applies against the sum of all of these individual allocations.
4234 ///
4235 /// The default value for this is 1MiB.
4236 ///
4237 /// This provides an upper-bound on the total size of all component's
4238 /// metadata-related allocations (for both the component and its embedded
4239 /// core module instances), along with
4240 /// [`PoolingAllocationConfig::total_component_instances`]. The upper bound is
4241 ///
4242 /// ```text
4243 /// total_component_instances * max_component_instance_size
4244 /// ```
4245 ///
4246 /// where `max_component_instance_size` is rounded up to the size and alignment
4247 /// of the internal representation of the metadata.
4248 pub fn max_component_instance_size(&mut self, size: usize) -> &mut Self {
4249 self.limits.component_instance_size = size;
4250 self
4251 }
4252
4253 /// The maximum number of core instances a single component may contain
4254 /// (default is unlimited).
4255 ///
4256 /// This method (along with
4257 /// [`PoolingAllocationConfig::max_memories_per_component`],
4258 /// [`PoolingAllocationConfig::max_tables_per_component`], and
4259 /// [`PoolingAllocationConfig::max_component_instance_size`]) allows you to cap
4260 /// the amount of resources a single component allocation consumes.
4261 ///
4262 /// If a component will instantiate more core instances than `count`, then
4263 /// the component will fail to instantiate.
4264 pub fn max_core_instances_per_component(&mut self, count: u32) -> &mut Self {
4265 self.limits.max_core_instances_per_component = count;
4266 self
4267 }
4268
4269 /// The maximum number of Wasm linear memories that a single component may
4270 /// transitively contain (default is unlimited).
4271 ///
4272 /// This method (along with
4273 /// [`PoolingAllocationConfig::max_core_instances_per_component`],
4274 /// [`PoolingAllocationConfig::max_tables_per_component`], and
4275 /// [`PoolingAllocationConfig::max_component_instance_size`]) allows you to cap
4276 /// the amount of resources a single component allocation consumes.
4277 ///
4278 /// If a component transitively contains more linear memories than `count`,
4279 /// then the component will fail to instantiate.
4280 pub fn max_memories_per_component(&mut self, count: u32) -> &mut Self {
4281 self.limits.max_memories_per_component = count;
4282 self
4283 }
4284
4285 /// The maximum number of tables that a single component may transitively
4286 /// contain (default is unlimited).
4287 ///
4288 /// This method (along with
4289 /// [`PoolingAllocationConfig::max_core_instances_per_component`],
4290 /// [`PoolingAllocationConfig::max_memories_per_component`],
4291 /// [`PoolingAllocationConfig::max_component_instance_size`]) allows you to cap
4292 /// the amount of resources a single component allocation consumes.
4293 ///
4294 /// If a component will transitively contains more tables than `count`, then
4295 /// the component will fail to instantiate.
4296 pub fn max_tables_per_component(&mut self, count: u32) -> &mut Self {
4297 self.limits.max_tables_per_component = count;
4298 self
4299 }
4300
4301 /// The maximum number of concurrent Wasm linear memories supported (default
4302 /// is `1000`).
4303 ///
4304 /// This value has a direct impact on the amount of memory allocated by the pooling
4305 /// instance allocator.
4306 ///
4307 /// The pooling instance allocator allocates a memory pool, where each entry
4308 /// in the pool contains the reserved address space for each linear memory
4309 /// supported by an instance.
4310 ///
4311 /// The memory pool will reserve a large quantity of host process address
4312 /// space to elide the bounds checks required for correct WebAssembly memory
4313 /// semantics. Even with 64-bit address spaces, the address space is limited
4314 /// when dealing with a large number of linear memories.
4315 ///
4316 /// For example, on Linux x86_64, the userland address space limit is 128
4317 /// TiB. That might seem like a lot, but each linear memory will *reserve* 6
4318 /// GiB of space by default.
4319 pub fn total_memories(&mut self, count: u32) -> &mut Self {
4320 self.limits.total_memories = count;
4321 self
4322 }
4323
4324 /// The maximum number of concurrent tables supported (default is `1000`).
4325 ///
4326 /// This value has a direct impact on the amount of memory allocated by the
4327 /// pooling instance allocator.
4328 ///
4329 /// The pooling instance allocator allocates a table pool, where each entry
4330 /// in the pool contains the space needed for each WebAssembly table
4331 /// supported by an instance (see `table_elements` to control the size of
4332 /// each table).
4333 pub fn total_tables(&mut self, count: u32) -> &mut Self {
4334 self.limits.total_tables = count;
4335 self
4336 }
4337
4338 /// The maximum number of execution stacks allowed for asynchronous
4339 /// execution, when enabled (default is `1000`).
4340 ///
4341 /// This value has a direct impact on the amount of memory allocated by the
4342 /// pooling instance allocator.
4343 #[cfg(feature = "async")]
4344 pub fn total_stacks(&mut self, count: u32) -> &mut Self {
4345 self.limits.total_stacks = count;
4346 self
4347 }
4348
4349 /// The maximum number of concurrent core instances supported (default is
4350 /// `1000`).
4351 ///
4352 /// This provides an upper-bound on the total size of core instance
4353 /// metadata-related allocations, along with
4354 /// [`PoolingAllocationConfig::max_core_instance_size`]. The upper bound is
4355 ///
4356 /// ```text
4357 /// total_core_instances * max_core_instance_size
4358 /// ```
4359 ///
4360 /// where `max_core_instance_size` is rounded up to the size and alignment of
4361 /// the internal representation of the metadata.
4362 pub fn total_core_instances(&mut self, count: u32) -> &mut Self {
4363 self.limits.total_core_instances = count;
4364 self
4365 }
4366
4367 /// The maximum size, in bytes, allocated for a core instance's `VMContext`
4368 /// metadata.
4369 ///
4370 /// The [`Instance`][crate::Instance] type has a static size but its
4371 /// `VMContext` metadata is dynamically sized depending on the module being
4372 /// instantiated. This size limit loosely correlates to the size of the Wasm
4373 /// module, taking into account factors such as:
4374 ///
4375 /// * number of functions
4376 /// * number of globals
4377 /// * number of memories
4378 /// * number of tables
4379 /// * number of function types
4380 ///
4381 /// If the allocated size per instance is too small then instantiation of a
4382 /// module will fail at runtime with an error indicating how many bytes were
4383 /// needed.
4384 ///
4385 /// The default value for this is 1MiB.
4386 ///
4387 /// This provides an upper-bound on the total size of core instance
4388 /// metadata-related allocations, along with
4389 /// [`PoolingAllocationConfig::total_core_instances`]. The upper bound is
4390 ///
4391 /// ```text
4392 /// total_core_instances * max_core_instance_size
4393 /// ```
4394 ///
4395 /// where `max_core_instance_size` is rounded up to the size and alignment of
4396 /// the internal representation of the metadata.
4397 pub fn max_core_instance_size(&mut self, size: usize) -> &mut Self {
4398 self.limits.core_instance_size = size;
4399 self
4400 }
4401
4402 /// The maximum number of defined tables for a core module (default is `1`).
4403 ///
4404 /// This value controls the capacity of the `VMTableDefinition` table in
4405 /// each instance's `VMContext` structure.
4406 ///
4407 /// The allocated size of the table will be `tables *
4408 /// sizeof(VMTableDefinition)` for each instance regardless of how many
4409 /// tables are defined by an instance's module.
4410 pub fn max_tables_per_module(&mut self, tables: u32) -> &mut Self {
4411 self.limits.max_tables_per_module = tables;
4412 self
4413 }
4414
4415 /// The maximum table elements for any table defined in a module (default is
4416 /// `20000`).
4417 ///
4418 /// If a table's minimum element limit is greater than this value, the
4419 /// module will fail to instantiate.
4420 ///
4421 /// If a table's maximum element limit is unbounded or greater than this
4422 /// value, the maximum will be `table_elements` for the purpose of any
4423 /// `table.grow` instruction.
4424 ///
4425 /// This value is used to reserve the maximum space for each supported
4426 /// table; table elements are pointer-sized in the Wasmtime runtime.
4427 /// Therefore, the space reserved for each instance is `tables *
4428 /// table_elements * sizeof::<*const ()>`.
4429 pub fn table_elements(&mut self, elements: usize) -> &mut Self {
4430 self.limits.table_elements = elements;
4431 self
4432 }
4433
4434 /// The maximum number of defined linear memories for a module (default is
4435 /// `1`).
4436 ///
4437 /// This value controls the capacity of the `VMMemoryDefinition` table in
4438 /// each core instance's `VMContext` structure.
4439 ///
4440 /// The allocated size of the table will be `memories *
4441 /// sizeof(VMMemoryDefinition)` for each core instance regardless of how
4442 /// many memories are defined by the core instance's module.
4443 pub fn max_memories_per_module(&mut self, memories: u32) -> &mut Self {
4444 self.limits.max_memories_per_module = memories;
4445 self
4446 }
4447
4448 /// The maximum byte size that any WebAssembly linear memory may grow to.
4449 ///
4450 /// This option defaults to 4 GiB meaning that for 32-bit linear memories
4451 /// there is no restrictions. 64-bit linear memories will not be allowed to
4452 /// grow beyond 4 GiB by default.
4453 ///
4454 /// If a memory's minimum size is greater than this value, the module will
4455 /// fail to instantiate.
4456 ///
4457 /// If a memory's maximum size is unbounded or greater than this value, the
4458 /// maximum will be `max_memory_size` for the purpose of any `memory.grow`
4459 /// instruction.
4460 ///
4461 /// This value is used to control the maximum accessible space for each
4462 /// linear memory of a core instance. This can be thought of as a simple
4463 /// mechanism like [`Store::limiter`](crate::Store::limiter) to limit memory
4464 /// at runtime. This value can also affect striping/coloring behavior when
4465 /// used in conjunction with
4466 /// [`memory_protection_keys`](PoolingAllocationConfig::memory_protection_keys).
4467 ///
4468 /// The virtual memory reservation size of each linear memory is controlled
4469 /// by the [`Config::memory_reservation`] setting and this method's
4470 /// configuration cannot exceed [`Config::memory_reservation`].
4471 pub fn max_memory_size(&mut self, bytes: usize) -> &mut Self {
4472 self.limits.max_memory_size = bytes;
4473 self
4474 }
4475
4476 /// Configures whether memory protection keys (MPK) should be used for more
4477 /// efficient layout of pool-allocated memories.
4478 ///
4479 /// When using the pooling allocator (see [`Config::allocation_strategy`],
4480 /// [`InstanceAllocationStrategy::Pooling`]), memory protection keys can
4481 /// reduce the total amount of allocated virtual memory by eliminating guard
4482 /// regions between WebAssembly memories in the pool. It does so by
4483 /// "coloring" memory regions with different memory keys and setting which
4484 /// regions are accessible each time executions switches from host to guest
4485 /// (or vice versa).
4486 ///
4487 /// Leveraging MPK requires configuring a smaller-than-default
4488 /// [`max_memory_size`](PoolingAllocationConfig::max_memory_size) to enable
4489 /// this coloring/striping behavior. For example embeddings might want to
4490 /// reduce the default 4G allowance to 128M.
4491 ///
4492 /// MPK is only available on Linux (called `pku` there) and recent x86
4493 /// systems; we check for MPK support at runtime by examining the `CPUID`
4494 /// register. This configuration setting can be in three states:
4495 ///
4496 /// - `auto`: if MPK support is available the guard regions are removed; if
4497 /// not, the guard regions remain
4498 /// - `yes`: use MPK to eliminate guard regions; fail if MPK is not
4499 /// supported
4500 /// - `no`: never use MPK
4501 ///
4502 /// By default this value is `no`, but may become `auto` in future
4503 /// releases.
4504 ///
4505 /// __WARNING__: this configuration options is still experimental--use at
4506 /// your own risk! MPK uses kernel and CPU features to protect memory
4507 /// regions; you may observe segmentation faults if anything is
4508 /// misconfigured.
4509 #[cfg(feature = "memory-protection-keys")]
4510 pub fn memory_protection_keys(&mut self, enable: Enabled) -> &mut Self {
4511 self.memory_protection_keys = enable;
4512 self
4513 }
4514
4515 /// Sets an upper limit on how many memory protection keys (MPK) Wasmtime
4516 /// will use.
4517 ///
4518 /// This setting is only applicable when
4519 /// [`PoolingAllocationConfig::memory_protection_keys`] is set to `enable`
4520 /// or `auto`. Configuring this above the HW and OS limits (typically 15)
4521 /// has no effect.
4522 ///
4523 /// If multiple Wasmtime engines are used in the same process, note that all
4524 /// engines will share the same set of allocated keys; this setting will
4525 /// limit how many keys are allocated initially and thus available to all
4526 /// other engines.
4527 #[cfg(feature = "memory-protection-keys")]
4528 pub fn max_memory_protection_keys(&mut self, max: usize) -> &mut Self {
4529 self.max_memory_protection_keys = max;
4530 self
4531 }
4532
4533 /// Check if memory protection keys (MPK) are available on the current host.
4534 ///
4535 /// This is a convenience method for determining MPK availability using the
4536 /// same method that [`Enabled::Auto`] does. See
4537 /// [`PoolingAllocationConfig::memory_protection_keys`] for more
4538 /// information.
4539 #[cfg(feature = "memory-protection-keys")]
4540 pub fn are_memory_protection_keys_available() -> bool {
4541 crate::runtime::vm::mpk::is_supported()
4542 }
4543
4544 /// The maximum number of concurrent GC heaps supported (default is `1000`).
4545 ///
4546 /// This value has a direct impact on the amount of memory allocated by the
4547 /// pooling instance allocator.
4548 ///
4549 /// The pooling instance allocator allocates a GC heap pool, where each
4550 /// entry in the pool contains the space needed for each GC heap used by a
4551 /// store.
4552 #[cfg(feature = "gc")]
4553 pub fn total_gc_heaps(&mut self, count: u32) -> &mut Self {
4554 self.limits.total_gc_heaps = count;
4555 self
4556 }
4557
4558 /// Configures whether the Linux-specific [`PAGEMAP_SCAN` ioctl][ioctl] is
4559 /// used to help reset linear memory.
4560 ///
4561 /// When [`Self::linear_memory_keep_resident`] or
4562 /// [`Self::table_keep_resident`] options are configured to nonzero values
4563 /// the default behavior is to `memset` the lowest addresses of a table or
4564 /// memory back to their original contents. With the `PAGEMAP_SCAN` ioctl on
4565 /// Linux this can be done to more intelligently scan for resident pages in
4566 /// the region and only reset those pages back to their original contents
4567 /// with `memset` rather than assuming the low addresses are all resident.
4568 ///
4569 /// This ioctl has the potential to provide a number of performance benefits
4570 /// in high-reuse and high concurrency scenarios. Notably this enables
4571 /// Wasmtime to scan the entire region of WebAssembly linear memory and
4572 /// manually reset memory back to its original contents, up to
4573 /// [`Self::linear_memory_keep_resident`] bytes, possibly skipping an
4574 /// `madvise` entirely. This can be more efficient by avoiding removing
4575 /// pages from the address space entirely and additionally ensuring that
4576 /// future use of the linear memory doesn't incur page faults as the pages
4577 /// remain resident.
4578 ///
4579 /// At this time this configuration option is still being evaluated as to
4580 /// how appropriate it is for all use cases. It currently defaults to
4581 /// `no` or disabled but may change to `auto`, enable if supported, in the
4582 /// future. This option is only supported on Linux and requires a kernel
4583 /// version of 6.7 or higher.
4584 ///
4585 /// [ioctl]: https://www.man7.org/linux/man-pages/man2/PAGEMAP_SCAN.2const.html
4586 pub fn pagemap_scan(&mut self, enable: Enabled) -> &mut Self {
4587 self.pagemap_scan = enable;
4588 self
4589 }
4590
4591 /// Returns the configured
4592 /// [`PoolingAllocationConfig::decommit_batch_size`], if enabled.
4593 pub fn get_decommit_batch_size(&self) -> usize {
4594 self.decommit_batch_size
4595 }
4596
4597 /// Returns the configured
4598 /// [`PoolingAllocationConfig::max_unused_warm_slots`], if enabled.
4599 pub fn get_max_unused_warm_slots(&self) -> u32 {
4600 self.max_unused_warm_slots
4601 }
4602
4603 /// Returns the configured
4604 /// [`PoolingAllocationConfig::linear_memory_keep_resident`], if
4605 /// enabled.
4606 pub fn get_memory_keep_resident(&self) -> usize {
4607 self.linear_memory_keep_resident
4608 }
4609
4610 /// Returns the configured
4611 /// [`PoolingAllocationConfig::table_keep_resident`], if enabled.
4612 pub fn get_table_keep_resident(&self) -> usize {
4613 self.table_keep_resident
4614 }
4615
4616 /// Returns the configured
4617 /// [`PoolingAllocationConfig::async_stack_keep_resident`], if
4618 /// enabled.
4619 pub fn get_async_stack_keep_resident(&self) -> usize {
4620 self.async_stack_keep_resident
4621 }
4622
4623 /// Returns the configured
4624 /// [`PoolingAllocationConfig::memory_protection_keys`], if enabled.
4625 pub fn get_memory_protection_keys(&self) -> Enabled {
4626 self.memory_protection_keys
4627 }
4628
4629 /// Returns the configured
4630 /// [`PoolingAllocationConfig::max_memory_protection_keys`], if
4631 /// enabled.
4632 pub fn get_max_memory_protection_keys(&self) -> usize {
4633 self.max_memory_protection_keys
4634 }
4635
4636 /// Returns the configured
4637 /// [`PoolingAllocationConfig::pagemap_scan`], if enabled.
4638 pub fn get_pagemap_scan(&self) -> Enabled {
4639 self.pagemap_scan
4640 }
4641
4642 /// Returns the configured
4643 /// [`PoolingAllocationConfig::total_core_instances`], if enabled.
4644 pub fn get_total_core_instances(&self) -> u32 {
4645 self.limits.total_core_instances
4646 }
4647
4648 /// Returns the configured
4649 /// [`PoolingAllocationConfig::total_component_instances`], if
4650 /// enabled.
4651 pub fn get_total_component_instances(&self) -> u32 {
4652 self.limits.total_component_instances
4653 }
4654
4655 /// Returns the configured
4656 /// [`PoolingAllocationConfig::total_memories`], if enabled.
4657 pub fn get_total_memories(&self) -> u32 {
4658 self.limits.total_memories
4659 }
4660
4661 /// Returns the configured
4662 /// [`PoolingAllocationConfig::total_tables`], if enabled.
4663 pub fn get_total_tables(&self) -> u32 {
4664 self.limits.total_tables
4665 }
4666
4667 /// Returns the configured
4668 /// [`PoolingAllocationConfig::total_stacks`], if enabled.
4669 pub fn get_total_stacks(&self) -> u32 {
4670 self.limits.total_stacks
4671 }
4672
4673 /// Returns the configured
4674 /// [`PoolingAllocationConfig::total_gc_heaps`], if enabled.
4675 pub fn get_total_gc_heaps(&self) -> u32 {
4676 self.limits.total_gc_heaps
4677 }
4678
4679 /// Returns the configured
4680 /// [`PoolingAllocationConfig::max_memory_size`], if enabled.
4681 pub fn get_max_memory_size(&self) -> usize {
4682 self.limits.max_memory_size
4683 }
4684
4685 /// Returns the configured
4686 /// [`PoolingAllocationConfig::table_elements`], if enabled.
4687 pub fn get_table_elements(&self) -> usize {
4688 self.limits.table_elements
4689 }
4690
4691 /// Returns the configured
4692 /// [`PoolingAllocationConfig::max_core_instance_size`], if enabled.
4693 pub fn get_max_core_instance_size(&self) -> usize {
4694 self.limits.core_instance_size
4695 }
4696
4697 /// Returns the configured
4698 /// [`PoolingAllocationConfig::max_component_instance_size`], if
4699 /// enabled.
4700 pub fn get_max_component_instance_size(&self) -> usize {
4701 self.limits.component_instance_size
4702 }
4703
4704 /// Returns the configured
4705 /// [`PoolingAllocationConfig::max_core_instances_per_component`], if
4706 /// enabled.
4707 pub fn get_max_core_instances_per_component(&self) -> u32 {
4708 self.limits.max_core_instances_per_component
4709 }
4710
4711 /// Returns the configured
4712 /// [`PoolingAllocationConfig::max_memories_per_component`], if
4713 /// enabled.
4714 pub fn get_max_memories_per_component(&self) -> u32 {
4715 self.limits.max_memories_per_component
4716 }
4717
4718 /// Returns the configured
4719 /// [`PoolingAllocationConfig::max_tables_per_component`], if enabled.
4720 pub fn get_max_tables_per_component(&self) -> u32 {
4721 self.limits.max_tables_per_component
4722 }
4723
4724 /// Returns the configured
4725 /// [`PoolingAllocationConfig::max_tables_per_module`], if enabled.
4726 pub fn get_max_tables_per_module(&self) -> u32 {
4727 self.limits.max_tables_per_module
4728 }
4729
4730 /// Returns the configured
4731 /// [`PoolingAllocationConfig::max_memories_per_module`], if enabled.
4732 pub fn get_max_memories_per_module(&self) -> u32 {
4733 self.limits.max_memories_per_module
4734 }
4735}
4736
4737#[cfg(feature = "std")]
4738fn detect_host_feature(feature: &str) -> Option<bool> {
4739 #[cfg(target_arch = "aarch64")]
4740 {
4741 return match feature {
4742 "lse" => Some(std::arch::is_aarch64_feature_detected!("lse")),
4743 "paca" => Some(std::arch::is_aarch64_feature_detected!("paca")),
4744 "fp16" => Some(std::arch::is_aarch64_feature_detected!("fp16")),
4745 "dotprod" => Some(std::arch::is_aarch64_feature_detected!("dotprod")),
4746 "i8mm" => Some(std::arch::is_aarch64_feature_detected!("i8mm")),
4747
4748 _ => None,
4749 };
4750 }
4751
4752 // `is_s390x_feature_detected` is nightly only for now, so use the
4753 // STORE FACILITY LIST EXTENDED instruction as a temporary measure.
4754 #[cfg(target_arch = "s390x")]
4755 {
4756 let mut facility_list: [u64; 4] = [0; 4];
4757 unsafe {
4758 core::arch::asm!(
4759 "stfle 0({})",
4760 in(reg_addr) facility_list.as_mut_ptr() ,
4761 inout("r0") facility_list.len() as u64 - 1 => _,
4762 options(nostack)
4763 );
4764 }
4765 let get_facility_bit = |n: usize| {
4766 // NOTE: bits are numbered from the left.
4767 facility_list[n / 64] & (1 << (63 - (n % 64))) != 0
4768 };
4769
4770 return match feature {
4771 "mie3" => Some(get_facility_bit(61)),
4772 "mie4" => Some(get_facility_bit(84)),
4773 "vxrs_ext2" => Some(get_facility_bit(148)),
4774 "vxrs_ext3" => Some(get_facility_bit(198)),
4775
4776 _ => None,
4777 };
4778 }
4779
4780 #[cfg(target_arch = "riscv64")]
4781 {
4782 return match feature {
4783 // due to `is_riscv64_feature_detected` is not stable.
4784 // we cannot use it. For now lie and say all features are always
4785 // found to keep tests working.
4786 _ => Some(true),
4787 };
4788 }
4789
4790 #[cfg(target_arch = "x86_64")]
4791 {
4792 return match feature {
4793 "cmpxchg16b" => Some(std::is_x86_feature_detected!("cmpxchg16b")),
4794 "sse3" => Some(std::is_x86_feature_detected!("sse3")),
4795 "ssse3" => Some(std::is_x86_feature_detected!("ssse3")),
4796 "sse4.1" => Some(std::is_x86_feature_detected!("sse4.1")),
4797 "sse4.2" => Some(std::is_x86_feature_detected!("sse4.2")),
4798 "popcnt" => Some(std::is_x86_feature_detected!("popcnt")),
4799 "avx" => Some(std::is_x86_feature_detected!("avx")),
4800 "avx2" => Some(std::is_x86_feature_detected!("avx2")),
4801 "fma" => Some(std::is_x86_feature_detected!("fma")),
4802 "avxvnni" => Some(std::is_x86_feature_detected!("avxvnni")),
4803 "bmi1" => Some(std::is_x86_feature_detected!("bmi1")),
4804 "bmi2" => Some(std::is_x86_feature_detected!("bmi2")),
4805 "avx512bitalg" => Some(std::is_x86_feature_detected!("avx512bitalg")),
4806 "avx512dq" => Some(std::is_x86_feature_detected!("avx512dq")),
4807 "avx512f" => Some(std::is_x86_feature_detected!("avx512f")),
4808 "avx512vl" => Some(std::is_x86_feature_detected!("avx512vl")),
4809 "avx512vbmi" => Some(std::is_x86_feature_detected!("avx512vbmi")),
4810 "avx512vnni" => Some(std::is_x86_feature_detected!("avx512vnni")),
4811 "lzcnt" => Some(std::is_x86_feature_detected!("lzcnt")),
4812
4813 _ => None,
4814 };
4815 }
4816
4817 #[allow(
4818 unreachable_code,
4819 reason = "reachable or not depending on if a target above matches"
4820 )]
4821 {
4822 let _ = feature;
4823 return None;
4824 }
4825}
4826
4827// What follows in this impl block is intended to be a somewhat-mechanical
4828// mostly-complete set of getters for relevant configuration options on
4829// `Config`. The `Config` type does not reflect a complete configuration so
4830// default values cannot be directly read from it. An `Engine`, however,
4831// represents a concrete and complete configuration with all default values
4832// fully specified. The purpose of these getters are then to perform a dual
4833// function of reflecting what was explicitly configured above as well as
4834// defaults that Wasmtime sets.
4835//
4836// The current pattern is:
4837//
4838// * All methods are `get_<config_name>`
4839// * Return values return `T` instead of `Option<T>` where possible unless the
4840// state for `T` is completely missing.
4841//
4842// This impl is primarily in service of
4843// `wasmtime_cli_flags::CommonOptions::from_engine` at this time, and CLI flags
4844// are not as comprehensive as `Config` options, but it's expected that the set
4845// will settle/grow over time.
4846impl Engine {
4847 /// Returns the configured [`Config::memory_may_move`] value.
4848 pub fn get_memory_may_move(&self) -> bool {
4849 self.tunables().memory_may_move
4850 }
4851
4852 /// Returns the configured [`Config::memory_reservation`] value.
4853 pub fn get_memory_reservation(&self) -> u64 {
4854 self.tunables().memory_reservation
4855 }
4856
4857 /// Returns the configured [`Config::memory_reservation_for_growth`] value.
4858 pub fn get_memory_reservation_for_growth(&self) -> u64 {
4859 self.tunables().memory_reservation_for_growth
4860 }
4861
4862 /// Returns the configured [`Config::memory_guard_size`] value.
4863 pub fn get_memory_guard_size(&self) -> u64 {
4864 self.tunables().memory_guard_size
4865 }
4866
4867 /// Returns the configured [`Config::gc_heap_may_move`] value.
4868 pub fn get_gc_heap_may_move(&self) -> bool {
4869 self.tunables().gc_heap_may_move
4870 }
4871
4872 /// Returns the configured [`Config::gc_heap_reservation`] value.
4873 pub fn get_gc_heap_reservation(&self) -> u64 {
4874 self.tunables().gc_heap_reservation
4875 }
4876
4877 /// Returns the configured [`Config::gc_heap_initial_size`] value.
4878 pub fn get_gc_heap_initial_size(&self) -> u64 {
4879 self.tunables().gc_heap_initial_size
4880 }
4881
4882 /// Returns the configured [`Config::gc_heap_reservation_for_growth`] value.
4883 pub fn get_gc_heap_reservation_for_growth(&self) -> u64 {
4884 self.tunables().gc_heap_reservation_for_growth
4885 }
4886
4887 /// Returns the configured [`Config::gc_heap_guard_size`] value.
4888 pub fn get_gc_heap_guard_size(&self) -> u64 {
4889 self.tunables().gc_heap_guard_size
4890 }
4891
4892 /// Returns the configured [`Config::guard_before_linear_memory`] value.
4893 pub fn get_guard_before_linear_memory(&self) -> bool {
4894 self.tunables().guard_before_linear_memory
4895 }
4896
4897 /// Returns the configured [`Config::table_lazy_init`] value.
4898 pub fn get_table_lazy_init(&self) -> bool {
4899 self.tunables().table_lazy_init
4900 }
4901
4902 /// Returns the configured [`Config::memory_init_cow`] value.
4903 pub fn get_memory_init_cow(&self) -> bool {
4904 self.tunables().memory_init_cow
4905 }
4906
4907 /// Returns the configured [`Config::memory_guaranteed_dense_image_size`] value.
4908 pub fn get_memory_guaranteed_dense_image_size(&self) -> u64 {
4909 self.config().memory_guaranteed_dense_image_size
4910 }
4911
4912 /// Returns the configured [`Config::signals_based_traps`] value.
4913 pub fn get_signals_based_traps(&self) -> bool {
4914 self.tunables().signals_based_traps
4915 }
4916
4917 /// Returns the configured [`Config::gc_zeal_alloc_counter`] value.
4918 pub fn get_gc_zeal_alloc_counter(&self) -> Option<core::num::NonZeroU32> {
4919 self.tunables().gc_zeal_alloc_counter
4920 }
4921
4922 /// Returns the configured [`Config::cranelift_opt_level`] value.
4923 pub fn get_cranelift_opt_level(&self) -> Option<OptLevel> {
4924 #[cfg(any(feature = "cranelift", feature = "winch"))]
4925 if let Some(compiler) = self.compiler() {
4926 let flags = compiler.flags();
4927 let (_, FlagValue::Enum(opt)) = flags.iter().find(|(f, _)| *f == "opt_level")? else {
4928 return None;
4929 };
4930 return match &opt[..] {
4931 "none" => Some(OptLevel::None),
4932 "speed" => Some(OptLevel::Speed),
4933 "speed_and_size" => Some(OptLevel::SpeedAndSize),
4934 _ => None,
4935 };
4936 }
4937 None
4938 }
4939
4940 /// Returns the configured [`Config::cranelift_regalloc_algorithm`] value.
4941 pub fn get_cranelift_regalloc_algorithm(&self) -> Option<RegallocAlgorithm> {
4942 #[cfg(any(feature = "cranelift", feature = "winch"))]
4943 if let Some(compiler) = self.compiler() {
4944 let flags = compiler.flags();
4945 let (_, FlagValue::Enum(opt)) =
4946 flags.iter().find(|(f, _)| *f == "regalloc_algorithm")?
4947 else {
4948 return None;
4949 };
4950 return match &opt[..] {
4951 "backtracking" => Some(RegallocAlgorithm::Backtracking),
4952 "single_pass" => Some(RegallocAlgorithm::SinglePass),
4953 _ => None,
4954 };
4955 }
4956 None
4957 }
4958
4959 /// Returns the configured [`Config::strategy`] value.
4960 pub fn get_strategy(&self) -> Option<Strategy> {
4961 #[cfg(any(feature = "cranelift", feature = "winch"))]
4962 return self.config().compiler_config.as_ref()?.strategy;
4963 #[cfg(not(any(feature = "cranelift", feature = "winch")))]
4964 return None;
4965 }
4966
4967 /// Returns the configured [`Config::collector`] value.
4968 pub fn get_collector(&self) -> Option<Collector> {
4969 #[cfg(feature = "gc")]
4970 return Some(self.config().collector);
4971 #[cfg(not(feature = "gc"))]
4972 return None;
4973 }
4974
4975 /// Returns the configured [`Config::cranelift_debug_verifier`] value.
4976 pub fn get_cranelift_debug_verifier(&self) -> Option<bool> {
4977 #[cfg(any(feature = "cranelift", feature = "winch"))]
4978 if let Some(compiler) = self.compiler() {
4979 let flags = compiler.flags();
4980 let (_, FlagValue::Bool(b)) = flags.iter().find(|(f, _)| *f == "enable_verifier")?
4981 else {
4982 return None;
4983 };
4984 return Some(*b);
4985 }
4986 None
4987 }
4988
4989 /// Returns the configured [`Config::compiler_inlining`] value.
4990 pub fn get_compiler_inlining(&self) -> Inlining {
4991 self.tunables().inlining
4992 }
4993
4994 /// Returns the configured [`Config::native_unwind_info`] value.
4995 pub fn get_native_unwind_info(&self) -> Option<bool> {
4996 #[cfg(any(feature = "cranelift", feature = "winch"))]
4997 if let Some(compiler) = self.compiler() {
4998 let flags = compiler.flags();
4999 let (_, FlagValue::Bool(b)) = flags.iter().find(|(f, _)| *f == "unwind_info")? else {
5000 return None;
5001 };
5002 return Some(*b);
5003 }
5004 None
5005 }
5006
5007 /// Returns the configured [`Config::parallel_compilation`] value.
5008 pub fn get_parallel_compilation(&self) -> bool {
5009 self.config().parallel_compilation
5010 }
5011
5012 /// Returns the configured [`Config::metadata_for_internal_asserts`] value.
5013 pub fn get_metadata_for_internal_asserts(&self) -> bool {
5014 self.tunables().metadata_for_internal_asserts
5015 }
5016
5017 /// Returns the configured [`Config::metadata_for_gc_heap_corruption`] value.
5018 pub fn get_metadata_for_gc_heap_corruption(&self) -> bool {
5019 self.tunables().metadata_for_gc_heap_corruption
5020 }
5021
5022 /// Returns the runtime pooling allocator configuration, if the pooling
5023 /// allocator is in use.
5024 pub fn get_pooling_config(&self) -> Option<&PoolingAllocationConfig> {
5025 #[cfg(feature = "pooling-allocator")]
5026 {
5027 Some(self.allocator().as_pooling()?.config())
5028 }
5029 #[cfg(not(feature = "pooling-allocator"))]
5030 {
5031 None
5032 }
5033 }
5034
5035 /// Returns the configured wasm proposals enabled in this engine.
5036 pub fn get_wasm_features(&self) -> WasmFeatures {
5037 self.features()
5038 }
5039
5040 /// Returns the configured [`Config::async_stack_size`] value.
5041 pub fn get_async_stack_size(&self) -> usize {
5042 self.config().async_stack_size
5043 }
5044
5045 /// Returns the configured [`Config::async_stack_zeroing`] value.
5046 pub fn get_async_stack_zeroing(&self) -> bool {
5047 self.config().async_stack_zeroing
5048 }
5049
5050 /// Returns the configured [`Config::wasm_branch_hinting`] value.
5051 pub fn get_wasm_branch_hinting(&self) -> bool {
5052 self.tunables().branch_hinting
5053 }
5054
5055 /// Returns the configured [`Config::concurrency_support`] value.
5056 pub fn get_concurrency_support(&self) -> bool {
5057 self.tunables().concurrency_support
5058 }
5059
5060 /// Returns the configured [`Config::epoch_interruption`] value.
5061 pub fn get_epoch_interruption(&self) -> bool {
5062 self.tunables().epoch_interruption
5063 }
5064
5065 /// Returns the configured [`Config::consume_fuel`] value.
5066 pub fn get_consume_fuel(&self) -> bool {
5067 self.tunables().consume_fuel
5068 }
5069
5070 /// Returns the configured [`Config::max_wasm_stack`] value.
5071 pub fn get_max_wasm_stack(&self) -> usize {
5072 self.config().max_wasm_stack
5073 }
5074
5075 /// Returns the configured [`Config::cranelift_nan_canonicalization`] value.
5076 pub fn get_cranelift_nan_canonicalization(&self) -> Option<bool> {
5077 #[cfg(any(feature = "cranelift", feature = "winch"))]
5078 if let Some(compiler) = self.compiler() {
5079 let flags = compiler.flags();
5080 let (_, FlagValue::Bool(b)) = flags
5081 .iter()
5082 .find(|(f, _)| *f == "enable_nan_canonicalization")?
5083 else {
5084 return None;
5085 };
5086 return Some(*b);
5087 }
5088 None
5089 }
5090
5091 /// Returns the configured [`Config::relaxed_simd_deterministic`] value.
5092 pub fn get_relaxed_simd_deterministic(&self) -> bool {
5093 self.tunables().relaxed_simd_deterministic
5094 }
5095
5096 /// Returns the configured [`Config::shared_memory`] value.
5097 pub fn get_shared_memory(&self) -> bool {
5098 self.config().shared_memory
5099 }
5100
5101 /// Returns the configured [`Config::generate_address_map`] value.
5102 pub fn get_generate_address_map(&self) -> bool {
5103 self.tunables().generate_address_map
5104 }
5105
5106 /// Returns the configured [`Config::debug_info`] value.
5107 pub fn get_debug_info(&self) -> bool {
5108 self.tunables().debug_native
5109 }
5110
5111 /// Returns the configured [`Config::guest_debug`] value.
5112 pub fn get_guest_debug(&self) -> bool {
5113 self.tunables().debug_guest
5114 }
5115
5116 /// Returns the configured [`Config::debug_symbols`] value.
5117 pub fn get_debug_symbols(&self) -> bool {
5118 self.tunables().debug_symbols
5119 }
5120
5121 /// Returns the configured [`Config::wasm_backtrace_max_frames`] value.
5122 pub fn get_wasm_backtrace_max_frames(&self) -> usize {
5123 self.config()
5124 .wasm_backtrace_max_frames
5125 .map(|f| f.get())
5126 .unwrap_or(0)
5127 }
5128
5129 /// Returns the configured [`Config::target`] value.
5130 pub fn get_target(&self) -> Option<String> {
5131 #[cfg(any(feature = "cranelift", feature = "winch"))]
5132 if let Some(compiler) = self.compiler() {
5133 return Some(compiler.triple().to_string());
5134 }
5135 None
5136 }
5137
5138 /// Returns the enabled flags via [`Config::cranelift_flag_enable`].
5139 pub fn get_cranelift_flags_enabled(&self) -> impl Iterator<Item = &str> {
5140 #[cfg(any(feature = "cranelift", feature = "winch"))]
5141 if let Some(config) = &self.config().compiler_config {
5142 return config
5143 .flags
5144 .iter()
5145 .filter_map(|(k, v)| match v {
5146 UserSpecified::Yes => Some(k.as_str()),
5147 UserSpecified::No => None,
5148 })
5149 .collect::<Vec<_>>()
5150 .into_iter();
5151 }
5152
5153 Vec::new().into_iter()
5154 }
5155
5156 /// Returns the enabled flags via [`Config::cranelift_flag_set`].
5157 pub fn get_cranelift_flags_set(&self) -> impl Iterator<Item = (&str, &str)> {
5158 #[cfg(any(feature = "cranelift", feature = "winch"))]
5159 if let Some(config) = &self.config().compiler_config {
5160 return config
5161 .settings
5162 .iter()
5163 .filter_map(|(k, (v, s))| match s {
5164 UserSpecified::Yes => Some((k.as_str(), v.as_str())),
5165 UserSpecified::No => None,
5166 })
5167 .collect::<Vec<_>>()
5168 .into_iter();
5169 }
5170
5171 Vec::new().into_iter()
5172 }
5173}