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 /// The default value for this option is whether the `component-model-async`
1306 /// crate feature of Wasmtime is enabled or not. By default this crate
1307 /// feature is enabled. This option is also disabled by default if
1308 /// [`Config::concurrency_support`] is disabled.
1309 ///
1310 /// [proposal]:
1311 /// https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1312 #[cfg(feature = "component-model-async")]
1313 pub fn wasm_component_model_async(&mut self, enable: bool) -> &mut Self {
1314 self.wasm_features(WasmFeatures::CM_ASYNC, enable);
1315 self
1316 }
1317
1318 /// This corresponds to the 🚝 emoji in the component model specification.
1319 ///
1320 /// Please note that Wasmtime's support for this feature is _very_
1321 /// incomplete.
1322 ///
1323 /// [proposal]:
1324 /// https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1325 #[cfg(feature = "component-model-async")]
1326 pub fn wasm_component_model_more_async_builtins(&mut self, enable: bool) -> &mut Self {
1327 self.wasm_features(WasmFeatures::CM_MORE_ASYNC_BUILTINS, enable);
1328 self
1329 }
1330
1331 /// This corresponds to the 🚟 emoji in the component model specification.
1332 ///
1333 /// Please note that Wasmtime's support for this feature is _very_
1334 /// incomplete.
1335 ///
1336 /// [proposal]: https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1337 #[cfg(feature = "component-model-async")]
1338 pub fn wasm_component_model_async_stackful(&mut self, enable: bool) -> &mut Self {
1339 self.wasm_features(WasmFeatures::CM_ASYNC_STACKFUL, enable);
1340 self
1341 }
1342
1343 /// This corresponds to the 🧵 emoji in the component model specification.
1344 ///
1345 /// Please note that Wasmtime's support for this feature is _very_
1346 /// incomplete.
1347 ///
1348 /// [proposal]:
1349 /// https://github.com/WebAssembly/component-model/pull/557
1350 #[cfg(feature = "component-model-async")]
1351 pub fn wasm_component_model_threading(&mut self, enable: bool) -> &mut Self {
1352 self.wasm_features(WasmFeatures::CM_THREADING, enable);
1353 self
1354 }
1355
1356 /// This corresponds to the 📝 emoji in the component model specification.
1357 ///
1358 /// Please note that Wasmtime's support for this feature is _very_
1359 /// incomplete.
1360 ///
1361 /// [proposal]: https://github.com/WebAssembly/component-model/blob/main/design/mvp/Concurrency.md
1362 #[cfg(feature = "component-model")]
1363 pub fn wasm_component_model_error_context(&mut self, enable: bool) -> &mut Self {
1364 self.wasm_features(WasmFeatures::CM_ERROR_CONTEXT, enable);
1365 self
1366 }
1367
1368 /// Configures whether the [GC extension to the component-model
1369 /// proposal][proposal] is enabled or not.
1370 ///
1371 /// This corresponds to the 🛸 emoji in the component model specification.
1372 ///
1373 /// Please note that Wasmtime's support for this feature is _very_
1374 /// incomplete.
1375 ///
1376 /// [proposal]: https://github.com/WebAssembly/component-model/issues/525
1377 #[cfg(feature = "component-model")]
1378 pub fn wasm_component_model_gc(&mut self, enable: bool) -> &mut Self {
1379 self.wasm_features(WasmFeatures::CM_GC, enable);
1380 self
1381 }
1382
1383 /// Configures whether the component model map type is enabled or not.
1384 ///
1385 /// This corresponds to the 🗺️ emoji in the component model specification
1386 /// and enables the `map<k, v>` type in WIT and the component binary
1387 /// format.
1388 ///
1389 /// This is `false` by default.
1390 #[cfg(feature = "component-model")]
1391 pub fn wasm_component_model_map(&mut self, enable: bool) -> &mut Self {
1392 self.wasm_features(WasmFeatures::CM_MAP, enable);
1393 self
1394 }
1395
1396 /// Configures whether the component model memory64 support is enabled
1397 ///
1398 /// This corresponds to the 🐘 emoji in the component model specification.
1399 ///
1400 /// Please note that Wasmtime's support for this feature is _very_
1401 /// incomplete.
1402 #[cfg(feature = "component-model")]
1403 pub fn wasm_component_model_memory64(&mut self, enable: bool) -> &mut Self {
1404 self.wasm_features(WasmFeatures::CM64, enable);
1405 self
1406 }
1407
1408 /// This corresponds to the 🔧 emoji in the component model specification.
1409 ///
1410 /// Please note that Wasmtime's support for this feature is _very_
1411 /// incomplete.
1412 #[cfg(feature = "component-model")]
1413 pub fn wasm_component_model_fixed_length_lists(&mut self, enable: bool) -> &mut Self {
1414 self.wasm_features(WasmFeatures::CM_FIXED_LENGTH_LISTS, enable);
1415 self
1416 }
1417
1418 /// This corresponds to the 🏷️ emoji in the component model specification.
1419 ///
1420 /// Please note that Wasmtime's support for this feature is a work in
1421 /// progress.
1422 #[cfg(feature = "component-model")]
1423 pub fn wasm_component_model_implements(&mut self, enable: bool) -> &mut Self {
1424 self.wasm_features(WasmFeatures::CM_IMPLEMENTS, enable);
1425 self
1426 }
1427
1428 /// This corresponds to the 🔗 emoji in the component model specification.
1429 ///
1430 /// Please note that Wasmtime's support for this feature is a work in
1431 /// progress.
1432 #[cfg(feature = "component-model")]
1433 pub fn wasm_component_model_canonical_names(&mut self, enable: bool) -> &mut Self {
1434 self.wasm_features(WasmFeatures::CM_CANON_NAMES, enable);
1435 self
1436 }
1437
1438 /// This corresponds to the 📡 emoji in the component model specification.
1439 ///
1440 /// Please note that Wasmtime's support for this feature is a work in
1441 /// progress.
1442 #[cfg(feature = "component-model")]
1443 pub fn wasm_component_model_accessors(&mut self, enable: bool) -> &mut Self {
1444 self.wasm_features(WasmFeatures::CM_ACCESSORS, enable);
1445 self
1446 }
1447
1448 /// Configures whether the [Exception-handling proposal][proposal] is enabled or not.
1449 ///
1450 /// This is `true` by default, except when using [`Strategy::Winch`] where
1451 /// it defaults to `false`.
1452 ///
1453 /// [proposal]: https://github.com/WebAssembly/exception-handling
1454 #[cfg(feature = "gc")]
1455 pub fn wasm_exceptions(&mut self, enable: bool) -> &mut Self {
1456 self.wasm_features(WasmFeatures::EXCEPTIONS, enable);
1457 self
1458 }
1459
1460 #[doc(hidden)] // FIXME(#3427) - if/when implemented then un-hide this
1461 #[deprecated = "This configuration option only exists for internal \
1462 usage with the spec testsuite. It may be removed at \
1463 any time and without warning. Do not rely on it!"]
1464 pub fn wasm_legacy_exceptions(&mut self, enable: bool) -> &mut Self {
1465 self.wasm_features(WasmFeatures::LEGACY_EXCEPTIONS, enable);
1466 self
1467 }
1468
1469 /// Configures which compilation strategy will be used for wasm modules.
1470 ///
1471 /// This method can be used to configure which compiler is used for wasm
1472 /// modules, and for more documentation consult the [`Strategy`] enumeration
1473 /// and its documentation.
1474 ///
1475 /// The default value for this is `Strategy::Auto`.
1476 ///
1477 /// # Panics
1478 ///
1479 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1480 #[cfg(any(feature = "cranelift", feature = "winch"))]
1481 pub fn strategy(&mut self, strategy: Strategy) -> &mut Self {
1482 self.compiler_config_mut().strategy = strategy.not_auto();
1483 self
1484 }
1485
1486 /// Configures which garbage collector will be used for Wasm modules.
1487 ///
1488 /// This method can be used to configure which garbage collector
1489 /// implementation is used for Wasm modules. For more documentation, consult
1490 /// the [`Collector`] enumeration and its documentation.
1491 ///
1492 /// The default value for this is `Collector::Auto`.
1493 #[cfg(feature = "gc")]
1494 pub fn collector(&mut self, collector: Collector) -> &mut Self {
1495 self.collector = collector;
1496 self
1497 }
1498
1499 /// Configures the initial size, in bytes, of each store's GC heap.
1500 ///
1501 /// By default all GC heaps start out at 0 bytes in size and must grow
1502 /// upwards from there. Growth happens incrementally as GC pressure happens
1503 /// and memory runs out. The amount being grown by is additionally a
1504 /// heuristic of the size of the failed allocation. By providing an initial
1505 /// size of a store's GC heap embedders can more tightly control initial
1506 /// parameters to optimize workloads that might have a predictable pattern.
1507 /// For example if workloads frequently have less than a certain threshold
1508 /// of size then that could be configured as the initial size here to avoid
1509 /// growths happening over time.
1510 ///
1511 /// Note that like WebAssembly linear memories the GC heap does not start
1512 /// with committed memory equal to this size. Instead memory is reserved,
1513 /// but then lazily allocated by the OS on access. In other words it should
1514 /// be relatively cheap to increase this value to help amortize initial
1515 /// startup cost of wasm modules.
1516 ///
1517 /// The `bytes` size is rounded up to the GC heap's page size.
1518 ///
1519 /// This only configures the initially-allocated size of the GC heap; the
1520 /// heap can still grow beyond it on demand. It is separate from
1521 /// [`Config::gc_heap_reservation`], which configures the size of the
1522 /// virtual-memory reservation (and therefore how far the heap can grow
1523 /// in place).
1524 ///
1525 /// The default value for this is 0.
1526 pub fn gc_heap_initial_size(&mut self, bytes: u64) -> &mut Self {
1527 self.tunables.gc_heap_initial_size = Some(bytes);
1528 self
1529 }
1530
1531 /// Creates a default profiler based on the profiling strategy chosen.
1532 ///
1533 /// Profiler creation calls the type's default initializer where the purpose is
1534 /// really just to put in place the type used for profiling.
1535 ///
1536 /// Some [`ProfilingStrategy`] require specific platforms or particular feature
1537 /// to be enabled, such as `ProfilingStrategy::JitDump` requires the `jitdump`
1538 /// feature.
1539 ///
1540 /// # Errors
1541 ///
1542 /// The validation of this field is deferred until the engine is being built, and thus may
1543 /// cause [`Engine::new`] fail if the required feature is disabled, or the platform is not
1544 /// supported.
1545 pub fn profiler(&mut self, profile: ProfilingStrategy) -> &mut Self {
1546 self.profiling_strategy = profile;
1547 self
1548 }
1549
1550 /// Configures whether the debug verifier of Cranelift is enabled or not.
1551 ///
1552 /// When Cranelift is used as a code generation backend this will configure
1553 /// it to have the `enable_verifier` flag which will enable a number of debug
1554 /// checks inside of Cranelift. This is largely only useful for the
1555 /// developers of wasmtime itself.
1556 ///
1557 /// The default value for this is `false`
1558 ///
1559 /// # Panics
1560 ///
1561 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1562 #[cfg(any(feature = "cranelift", feature = "winch"))]
1563 pub fn cranelift_debug_verifier(&mut self, enable: bool) -> &mut Self {
1564 let val = if enable { "true" } else { "false" };
1565 self.compiler_config_mut().settings.insert(
1566 "enable_verifier".to_string(),
1567 (val.to_string(), UserSpecified::No),
1568 );
1569 self
1570 }
1571
1572 /// Configures whether extra debug checks are inserted into
1573 /// Wasmtime-generated code by Cranelift.
1574 ///
1575 /// The default value for this is `false`
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_wasmtime_debug_checks(&mut self, enable: bool) -> &mut Self {
1582 unsafe { self.cranelift_flag_set("wasmtime_debug_checks", &enable.to_string()) }
1583 }
1584
1585 /// Configures the Cranelift code generator optimization level.
1586 ///
1587 /// When the Cranelift code generator is used you can configure the
1588 /// optimization level used for generated code in a few various ways. For
1589 /// more information see the documentation of [`OptLevel`].
1590 ///
1591 /// The default value for this is `OptLevel::Speed`.
1592 ///
1593 /// # Panics
1594 ///
1595 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1596 #[cfg(any(feature = "cranelift", feature = "winch"))]
1597 pub fn cranelift_opt_level(&mut self, level: OptLevel) -> &mut Self {
1598 let val = match level {
1599 OptLevel::None => "none",
1600 OptLevel::Speed => "speed",
1601 OptLevel::SpeedAndSize => "speed_and_size",
1602 };
1603 self.compiler_config_mut().settings.insert(
1604 "opt_level".to_string(),
1605 (val.to_string(), UserSpecified::No),
1606 );
1607 self
1608 }
1609
1610 /// Configures the regalloc algorithm used by the Cranelift code generator.
1611 ///
1612 /// Cranelift can select any of several register allocator algorithms. Each
1613 /// of these algorithms generates correct code, but they represent different
1614 /// tradeoffs between compile speed (how expensive the compilation process
1615 /// is) and run-time speed (how fast the generated code runs).
1616 /// For more information see the documentation of [`RegallocAlgorithm`].
1617 ///
1618 /// The default value for this is `RegallocAlgorithm::Backtracking`.
1619 ///
1620 /// # Panics
1621 ///
1622 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1623 #[cfg(any(feature = "cranelift", feature = "winch"))]
1624 pub fn cranelift_regalloc_algorithm(&mut self, algo: RegallocAlgorithm) -> &mut Self {
1625 let val = match algo {
1626 RegallocAlgorithm::Backtracking => "backtracking",
1627 RegallocAlgorithm::SinglePass => "single_pass",
1628 };
1629 self.compiler_config_mut().settings.insert(
1630 "regalloc_algorithm".to_string(),
1631 (val.to_string(), UserSpecified::No),
1632 );
1633 self
1634 }
1635
1636 /// Configures whether Cranelift should perform a NaN-canonicalization pass.
1637 ///
1638 /// When Cranelift is used as a code generation backend this will configure
1639 /// it to replace NaNs with a single canonical value. This is useful for
1640 /// users requiring entirely deterministic WebAssembly computation. This is
1641 /// not required by the WebAssembly spec, so it is not enabled by default.
1642 ///
1643 /// Note that this option affects not only WebAssembly's `f32` and `f64`
1644 /// types but additionally the `v128` type. This option will cause
1645 /// operations using any of these types to have extra checks placed after
1646 /// them to normalize NaN values as needed.
1647 ///
1648 /// The default value for this is `false`
1649 ///
1650 /// # Panics
1651 ///
1652 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1653 #[cfg(any(feature = "cranelift", feature = "winch"))]
1654 pub fn cranelift_nan_canonicalization(&mut self, enable: bool) -> &mut Self {
1655 let val = if enable { "true" } else { "false" };
1656 self.compiler_config_mut().settings.insert(
1657 "enable_nan_canonicalization".to_string(),
1658 (val.to_string(), UserSpecified::No),
1659 );
1660 self
1661 }
1662
1663 /// Allows setting a Cranelift boolean flag or preset. This allows
1664 /// fine-tuning of Cranelift settings.
1665 ///
1666 /// Since Cranelift flags may be unstable, this method should not be considered to be stable
1667 /// either; other `Config` functions should be preferred for stability.
1668 ///
1669 /// # Safety
1670 ///
1671 /// This is marked as unsafe, because setting the wrong flag might break invariants,
1672 /// resulting in execution hazards.
1673 ///
1674 /// # Errors
1675 ///
1676 /// The validation of the flags are deferred until the engine is being built, and thus may
1677 /// cause [`Engine::new`] fail if the flag's name does not exist, or the value is not appropriate
1678 /// for the flag type.
1679 ///
1680 /// # Panics
1681 ///
1682 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1683 #[cfg(any(feature = "cranelift", feature = "winch"))]
1684 pub unsafe fn cranelift_flag_enable(&mut self, flag: &str) -> &mut Self {
1685 self.compiler_config_mut()
1686 .flags
1687 .insert(flag.to_string(), UserSpecified::Yes);
1688 self
1689 }
1690
1691 /// Allows settings another Cranelift flag defined by a flag name and value. This allows
1692 /// fine-tuning of Cranelift settings.
1693 ///
1694 /// Since Cranelift flags may be unstable, this method should not be considered to be stable
1695 /// either; other `Config` functions should be preferred for stability.
1696 ///
1697 /// # Safety
1698 ///
1699 /// This is marked as unsafe, because setting the wrong flag might break invariants,
1700 /// resulting in execution hazards.
1701 ///
1702 /// # Errors
1703 ///
1704 /// The validation of the flags are deferred until the engine is being built, and thus may
1705 /// cause [`Engine::new`] fail if the flag's name does not exist, or incompatible with other
1706 /// settings.
1707 ///
1708 /// For example, feature `wasm_backtrace` will set `unwind_info` to `true`, but if it's
1709 /// manually set to false then it will fail.
1710 ///
1711 /// # Panics
1712 ///
1713 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
1714 #[cfg(any(feature = "cranelift", feature = "winch"))]
1715 pub unsafe fn cranelift_flag_set(&mut self, name: &str, value: &str) -> &mut Self {
1716 self.compiler_config_mut()
1717 .settings
1718 .insert(name.to_string(), (value.to_string(), UserSpecified::Yes));
1719 self
1720 }
1721
1722 /// Set a custom [`Cache`].
1723 ///
1724 /// To load a cache configuration from a file, use [`Cache::from_file`]. Otherwise, you can
1725 /// create a new cache config using [`CacheConfig::new`] and passing that to [`Cache::new`].
1726 ///
1727 /// If you want to disable the cache, you can call this method with `None`.
1728 ///
1729 /// By default, new configs do not have caching enabled.
1730 /// Every call to [`Module::new(my_wasm)`][crate::Module::new] will recompile `my_wasm`,
1731 /// even when it is unchanged, unless an enabled `CacheConfig` is provided.
1732 ///
1733 /// This method is only available when the `cache` feature of this crate is
1734 /// enabled.
1735 ///
1736 /// [docs]: https://bytecodealliance.github.io/wasmtime/cli-cache.html
1737 #[cfg(feature = "cache")]
1738 pub fn cache(&mut self, cache: Option<Cache>) -> &mut Self {
1739 self.cache = cache;
1740 self
1741 }
1742
1743 /// Sets a custom memory creator.
1744 ///
1745 /// Custom memory creators are used when creating host `Memory` objects or when
1746 /// creating instance linear memories for the on-demand instance allocation strategy.
1747 #[cfg(feature = "runtime")]
1748 pub fn with_host_memory(&mut self, mem_creator: Arc<dyn MemoryCreator>) -> &mut Self {
1749 self.mem_creator = Some(Arc::new(MemoryCreatorProxy(mem_creator)));
1750 self
1751 }
1752
1753 /// Sets a custom stack creator.
1754 ///
1755 /// Custom memory creators are used when creating creating async instance stacks for
1756 /// the on-demand instance allocation strategy.
1757 #[cfg(feature = "async")]
1758 pub fn with_host_stack(&mut self, stack_creator: Arc<dyn StackCreator>) -> &mut Self {
1759 self.stack_creator = Some(Arc::new(StackCreatorProxy(stack_creator)));
1760 self
1761 }
1762
1763 /// Sets a custom executable-memory publisher.
1764 ///
1765 /// Custom executable-memory publishers are hooks that allow
1766 /// Wasmtime to make certain regions of memory executable when
1767 /// loading precompiled modules or compiling new modules
1768 /// in-process. In most modern operating systems, memory allocated
1769 /// for heap usage is readable and writable by default but not
1770 /// executable. To jump to machine code stored in that memory, we
1771 /// need to make it executable. For security reasons, we usually
1772 /// also make it read-only at the same time, so the executing code
1773 /// can't be modified later.
1774 ///
1775 /// By default, Wasmtime will use the appropriate system calls on
1776 /// the host platform for this work. However, it also allows
1777 /// plugging in a custom implementation via this configuration
1778 /// option. This may be useful on custom or `no_std` platforms,
1779 /// for example, especially where virtual memory is not otherwise
1780 /// used by Wasmtime (no `signals-and-traps` feature).
1781 #[cfg(feature = "runtime")]
1782 pub fn with_custom_code_memory(
1783 &mut self,
1784 custom_code_memory: Option<Arc<dyn CustomCodeMemory>>,
1785 ) -> &mut Self {
1786 self.custom_code_memory = custom_code_memory;
1787 self
1788 }
1789
1790 /// Sets the instance allocation strategy to use.
1791 ///
1792 /// This is notably used in conjunction with
1793 /// [`InstanceAllocationStrategy::Pooling`] and [`PoolingAllocationConfig`].
1794 pub fn allocation_strategy(
1795 &mut self,
1796 strategy: impl Into<InstanceAllocationStrategy>,
1797 ) -> &mut Self {
1798 self.allocation_strategy = strategy.into();
1799 self
1800 }
1801
1802 /// Specifies the capacity of linear memories, in bytes, in their initial
1803 /// allocation.
1804 ///
1805 /// > Note: this value has important performance ramifications, be sure to
1806 /// > benchmark when setting this to a non-default value and read over this
1807 /// > documentation.
1808 ///
1809 /// This function will change the size of the initial memory allocation made
1810 /// for linear memories. This setting is only applicable when the initial
1811 /// size of a linear memory is below this threshold. Linear memories are
1812 /// allocated in the virtual address space of the host process with OS APIs
1813 /// such as `mmap` and this setting affects how large the allocation will
1814 /// be.
1815 ///
1816 /// ## Background: WebAssembly Linear Memories
1817 ///
1818 /// WebAssembly linear memories always start with a minimum size and can
1819 /// possibly grow up to a maximum size. The minimum size is always specified
1820 /// in a WebAssembly module itself and the maximum size can either be
1821 /// optionally specified in the module or inherently limited by the index
1822 /// type. For example for this module:
1823 ///
1824 /// ```wasm
1825 /// (module
1826 /// (memory $a 4)
1827 /// (memory $b 4096 4096 (pagesize 1))
1828 /// (memory $c i64 10)
1829 /// )
1830 /// ```
1831 ///
1832 /// * Memory `$a` initially allocates 4 WebAssembly pages (256KiB) and can
1833 /// grow up to 4GiB, the limit of the 32-bit index space.
1834 /// * Memory `$b` initially allocates 4096 WebAssembly pages, but in this
1835 /// case its page size is 1, so it's 4096 bytes. Memory can also grow no
1836 /// further meaning that it will always be 4096 bytes.
1837 /// * Memory `$c` is a 64-bit linear memory which starts with 640KiB of
1838 /// memory and can theoretically grow up to 2^64 bytes, although most
1839 /// hosts will run out of memory long before that.
1840 ///
1841 /// All operations on linear memories done by wasm are required to be
1842 /// in-bounds. Any access beyond the end of a linear memory is considered a
1843 /// trap.
1844 ///
1845 /// ## What this setting affects: Virtual Memory
1846 ///
1847 /// This setting is used to configure the behavior of the size of the linear
1848 /// memory allocation performed for each of these memories. For example the
1849 /// initial linear memory allocation looks like this:
1850 ///
1851 /// ```text
1852 /// memory_reservation
1853 /// |
1854 /// ◄─────────┴────────────────►
1855 /// ┌───────┬─────────┬──────────────────┬───────┐
1856 /// │ guard │ initial │ ... capacity ... │ guard │
1857 /// └───────┴─────────┴──────────────────┴───────┘
1858 /// ◄──┬──► ◄──┬──►
1859 /// │ │
1860 /// │ memory_guard_size
1861 /// │
1862 /// │
1863 /// memory_guard_size (if guard_before_linear_memory)
1864 /// ```
1865 ///
1866 /// Memory in the `initial` range is accessible to the instance and can be
1867 /// read/written by wasm code. Memory in the `guard` regions is never
1868 /// accessible to wasm code and memory in `capacity` is initially
1869 /// inaccessible but may become accessible through `memory.grow` instructions
1870 /// for example.
1871 ///
1872 /// This means that this setting is the size of the initial chunk of virtual
1873 /// memory that a linear memory may grow into.
1874 ///
1875 /// ## What this setting affects: Runtime Speed
1876 ///
1877 /// This is a performance-sensitive setting which is taken into account
1878 /// during the compilation process of a WebAssembly module. For example if a
1879 /// 32-bit WebAssembly linear memory has a `memory_reservation` size of 4GiB
1880 /// then bounds checks can be elided because `capacity` will be guaranteed
1881 /// to be unmapped for all addressable bytes that wasm can access (modulo a
1882 /// few details).
1883 ///
1884 /// If `memory_reservation` was something smaller like 256KiB then that
1885 /// would have a much smaller impact on virtual memory but the compile code
1886 /// would then need to have explicit bounds checks to ensure that
1887 /// loads/stores are in-bounds.
1888 ///
1889 /// The goal of this setting is to enable skipping bounds checks in most
1890 /// modules by default. Some situations which require explicit bounds checks
1891 /// though are:
1892 ///
1893 /// * When `memory_reservation` is smaller than the addressable size of the
1894 /// linear memory. For example if 64-bit linear memories always need
1895 /// bounds checks as they can address the entire virtual address spacce.
1896 /// For 32-bit linear memories a `memory_reservation` minimum size of 4GiB
1897 /// is required to elide bounds checks.
1898 ///
1899 /// * When linear memories have a page size of 1 then bounds checks are
1900 /// required. In this situation virtual memory can't be relied upon
1901 /// because that operates at the host page size granularity where wasm
1902 /// requires a per-byte level granularity.
1903 ///
1904 /// * Configuration settings such as [`Config::signals_based_traps`] can be
1905 /// used to disable the use of signal handlers and virtual memory so
1906 /// explicit bounds checks are required.
1907 ///
1908 /// * When [`Config::memory_guard_size`] is too small a bounds check may be
1909 /// required. For 32-bit wasm addresses are actually 33-bit effective
1910 /// addresses because loads/stores have a 32-bit static offset to add to
1911 /// the dynamic 32-bit address. If the static offset is larger than the
1912 /// size of the guard region then an explicit bounds check is required.
1913 ///
1914 /// ## What this setting affects: Memory Growth Behavior
1915 ///
1916 /// In addition to affecting bounds checks emitted in compiled code this
1917 /// setting also affects how WebAssembly linear memories are grown. The
1918 /// `memory.grow` instruction can be used to make a linear memory larger and
1919 /// this is also affected by APIs such as
1920 /// [`Memory::grow`](crate::Memory::grow).
1921 ///
1922 /// In these situations when the amount being grown is small enough to fit
1923 /// within the remaining capacity then the linear memory doesn't have to be
1924 /// moved at runtime. If the capacity runs out though then a new linear
1925 /// memory allocation must be made and the contents of linear memory is
1926 /// copied over.
1927 ///
1928 /// For example here's a situation where a copy happens:
1929 ///
1930 /// * The `memory_reservation` setting is configured to 128KiB.
1931 /// * A WebAssembly linear memory starts with a single 64KiB page.
1932 /// * This memory can be grown by one page to contain the full 128KiB of
1933 /// memory.
1934 /// * If grown by one more page, though, then a 192KiB allocation must be
1935 /// made and the previous 128KiB of contents are copied into the new
1936 /// allocation.
1937 ///
1938 /// This growth behavior can have a significant performance impact if lots
1939 /// of data needs to be copied on growth. Conversely if memory growth never
1940 /// needs to happen because the capacity will always be large enough then
1941 /// optimizations can be applied to cache the base pointer of linear memory.
1942 ///
1943 /// When memory is grown then the
1944 /// [`Config::memory_reservation_for_growth`] is used for the new
1945 /// memory allocation to have memory to grow into.
1946 ///
1947 /// When using the pooling allocator via [`PoolingAllocationConfig`] then
1948 /// memories are never allowed to move so requests for growth are instead
1949 /// rejected with an error.
1950 ///
1951 /// ## When this setting is not used
1952 ///
1953 /// This setting is ignored and unused when the initial size of linear
1954 /// memory is larger than this threshold. For example if this setting is set
1955 /// to 1MiB but a wasm module requires a 2MiB minimum allocation then this
1956 /// setting is ignored. In this situation the minimum size of memory will be
1957 /// allocated along with [`Config::memory_reservation_for_growth`]
1958 /// after it to grow into.
1959 ///
1960 /// That means that this value can be set to zero. That can be useful in
1961 /// benchmarking to see the overhead of bounds checks for example.
1962 /// Additionally it can be used to minimize the virtual memory allocated by
1963 /// Wasmtime.
1964 ///
1965 /// ## Default Value
1966 ///
1967 /// The default value for this property depends on the host platform. For
1968 /// 64-bit platforms there's lots of address space available, so the default
1969 /// configured here is 4GiB. When coupled with the default size of
1970 /// [`Config::memory_guard_size`] this means that 32-bit WebAssembly linear
1971 /// memories with 64KiB page sizes will skip almost all bounds checks by
1972 /// default.
1973 ///
1974 /// For 32-bit platforms this value defaults to 10MiB. This means that
1975 /// bounds checks will be required on 32-bit platforms.
1976 pub fn memory_reservation(&mut self, bytes: u64) -> &mut Self {
1977 self.tunables.memory_reservation = Some(bytes);
1978 self
1979 }
1980
1981 /// Indicates whether linear memories may relocate their base pointer at
1982 /// runtime.
1983 ///
1984 /// WebAssembly linear memories either have a maximum size that's explicitly
1985 /// listed in the type of a memory or inherently limited by the index type
1986 /// of the memory (e.g. 4GiB for 32-bit linear memories). Depending on how
1987 /// the linear memory is allocated (see [`Config::memory_reservation`]) it
1988 /// may be necessary to move the memory in the host's virtual address space
1989 /// during growth. This option controls whether this movement is allowed or
1990 /// not.
1991 ///
1992 /// An example of a linear memory needing to move is when
1993 /// [`Config::memory_reservation`] is 0 then a linear memory will be
1994 /// allocated as the minimum size of the memory plus
1995 /// [`Config::memory_reservation_for_growth`]. When memory grows beyond the
1996 /// reservation for growth then the memory needs to be relocated.
1997 ///
1998 /// When this option is set to `false` then it can have a number of impacts
1999 /// on how memories work at runtime:
2000 ///
2001 /// * Modules can be compiled with static knowledge the base pointer of
2002 /// linear memory never changes to enable optimizations such as
2003 /// loop invariant code motion (hoisting the base pointer out of a loop).
2004 ///
2005 /// * Memories cannot grow in excess of their original allocation. This
2006 /// means that [`Config::memory_reservation`] and
2007 /// [`Config::memory_reservation_for_growth`] may need tuning to ensure
2008 /// the memory configuration works at runtime.
2009 ///
2010 /// The default value for this option is `true`.
2011 pub fn memory_may_move(&mut self, enable: bool) -> &mut Self {
2012 self.tunables.memory_may_move = Some(enable);
2013 self
2014 }
2015
2016 /// Configures the size, in bytes, of the guard region used at the end of a
2017 /// linear memory's address space reservation.
2018 ///
2019 /// > Note: this value has important performance ramifications, be sure to
2020 /// > understand what this value does before tweaking it and benchmarking.
2021 ///
2022 /// This setting controls how many bytes are guaranteed to be unmapped after
2023 /// the virtual memory allocation of a linear memory. When
2024 /// combined with sufficiently large values of
2025 /// [`Config::memory_reservation`] (e.g. 4GiB for 32-bit linear memories)
2026 /// then a guard region can be used to eliminate bounds checks in generated
2027 /// code.
2028 ///
2029 /// This setting additionally can be used to help deduplicate bounds checks
2030 /// in code that otherwise requires bounds checks. For example with a 4KiB
2031 /// guard region then a 64-bit linear memory which accesses addresses `x+8`
2032 /// and `x+16` only needs to perform a single bounds check on `x`. If that
2033 /// bounds check passes then the offset is guaranteed to either reside in
2034 /// linear memory or the guard region, resulting in deterministic behavior
2035 /// either way.
2036 ///
2037 /// ## How big should the guard be?
2038 ///
2039 /// In general, like with configuring [`Config::memory_reservation`], you
2040 /// probably don't want to change this value from the defaults. Removing
2041 /// bounds checks is dependent on a number of factors where the size of the
2042 /// guard region is only one piece of the equation. Other factors include:
2043 ///
2044 /// * [`Config::memory_reservation`]
2045 /// * The index type of the linear memory (e.g. 32-bit or 64-bit)
2046 /// * The page size of the linear memory
2047 /// * Other settings such as [`Config::signals_based_traps`]
2048 ///
2049 /// Embeddings using virtual memory almost always want at least some guard
2050 /// region, but otherwise changes from the default should be profiled
2051 /// locally to see the performance impact.
2052 ///
2053 /// ## Default
2054 ///
2055 /// The default value for this property is 32MiB on 64-bit platforms. This
2056 /// allows eliminating almost all bounds checks on loads/stores with an
2057 /// immediate offset of less than 32MiB. On 32-bit platforms this defaults
2058 /// to 64KiB.
2059 pub fn memory_guard_size(&mut self, bytes: u64) -> &mut Self {
2060 self.tunables.memory_guard_size = Some(bytes);
2061 self
2062 }
2063
2064 /// Configures the size, in bytes, of the extra virtual memory space
2065 /// reserved after a linear memory is relocated.
2066 ///
2067 /// This setting is used in conjunction with [`Config::memory_reservation`]
2068 /// to configure what happens after a linear memory is relocated in the host
2069 /// address space. If the initial size of a linear memory exceeds
2070 /// [`Config::memory_reservation`] or if it grows beyond that size
2071 /// throughout its lifetime then this setting will be used.
2072 ///
2073 /// When a linear memory is relocated it will initially look like this:
2074 ///
2075 /// ```text
2076 /// memory.size
2077 /// │
2078 /// ◄──────┴─────►
2079 /// ┌───────┬──────────────┬───────┐
2080 /// │ guard │ accessible │ guard │
2081 /// └───────┴──────────────┴───────┘
2082 /// ◄──┬──►
2083 /// │
2084 /// memory_guard_size
2085 /// ```
2086 ///
2087 /// where `accessible` needs to be grown but there's no more memory to grow
2088 /// into. A new region of the virtual address space will be allocated that
2089 /// looks like this:
2090 ///
2091 /// ```text
2092 /// memory_reservation_for_growth
2093 /// │
2094 /// memory.size │
2095 /// │ │
2096 /// ◄──────┴─────► ◄─────────────┴───────────►
2097 /// ┌───────┬──────────────┬───────────────────────────┬───────┐
2098 /// │ guard │ accessible │ .. reserved for growth .. │ guard │
2099 /// └───────┴──────────────┴───────────────────────────┴───────┘
2100 /// ◄──┬──►
2101 /// │
2102 /// memory_guard_size
2103 /// ```
2104 ///
2105 /// This means that up to `memory_reservation_for_growth` bytes can be
2106 /// allocated again before the entire linear memory needs to be moved again
2107 /// when another `memory_reservation_for_growth` bytes will be appended to
2108 /// the size of the allocation.
2109 ///
2110 /// Note that this is a currently simple heuristic for optimizing the growth
2111 /// of dynamic memories, primarily implemented for the memory64 proposal
2112 /// where the maximum size of memory is larger than 4GiB. This setting is
2113 /// unlikely to be a one-size-fits-all style approach and if you're an
2114 /// embedder running into issues with growth and are interested in having
2115 /// other growth strategies available here please feel free to [open an
2116 /// issue on the Wasmtime repository][issue]!
2117 ///
2118 /// [issue]: https://github.com/bytecodealliance/wasmtime/issues/new
2119 ///
2120 /// ## Default
2121 ///
2122 /// For 64-bit platforms this defaults to 2GiB, and for 32-bit platforms
2123 /// this defaults to 1MiB.
2124 pub fn memory_reservation_for_growth(&mut self, bytes: u64) -> &mut Self {
2125 self.tunables.memory_reservation_for_growth = Some(bytes);
2126 self
2127 }
2128
2129 /// Configures the initial size, in bytes, to be allocated for GC heaps.
2130 ///
2131 /// This is similar to [`Config::memory_reservation`] but applies to the GC
2132 /// heap rather than to linear memories. See that method for more details
2133 /// on what "reservation" means and the implications of this setting.
2134 ///
2135 /// ## Default
2136 ///
2137 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2138 /// default to the same values as their `memory_*` counterparts. Otherwise,
2139 /// the default value for this property depends on the host platform: for
2140 /// 64-bit platforms this defaults to 4GiB, and for 32-bit platforms this
2141 /// defaults to 10MiB.
2142 pub fn gc_heap_reservation(&mut self, bytes: u64) -> &mut Self {
2143 self.tunables.gc_heap_reservation = Some(bytes);
2144 self
2145 }
2146
2147 /// Configures the size, in bytes, of the guard page region for GC heaps.
2148 ///
2149 /// This is similar to [`Config::memory_guard_size`] but applies to the GC
2150 /// heap rather than to linear memories. See that method for more details on
2151 /// what guard pages are and the implications of this setting.
2152 ///
2153 /// ## Default
2154 ///
2155 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2156 /// default to the same values as their `memory_*` counterparts. Otherwise,
2157 /// the default value for this property is 32MiB on 64-bit platforms and
2158 /// 64KiB on 32-bit platforms.
2159 pub fn gc_heap_guard_size(&mut self, bytes: u64) -> &mut Self {
2160 self.tunables.gc_heap_guard_size = Some(bytes);
2161 self
2162 }
2163
2164 /// Configures the size, in bytes, of the extra virtual memory space
2165 /// reserved after a GC heap is relocated.
2166 ///
2167 /// This is similar to [`Config::memory_reservation_for_growth`] but applies
2168 /// to the GC heap rather than to linear memories. See that method for more
2169 /// details.
2170 ///
2171 /// ## Default
2172 ///
2173 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2174 /// default to the same values as their `memory_*` counterparts. Otherwise,
2175 /// for 64-bit platforms this defaults to 2GiB, and for 32-bit platforms
2176 /// this defaults to 1MiB.
2177 pub fn gc_heap_reservation_for_growth(&mut self, bytes: u64) -> &mut Self {
2178 self.tunables.gc_heap_reservation_for_growth = Some(bytes);
2179 self
2180 }
2181
2182 /// Indicates whether GC heaps are allowed to be reallocated after initial
2183 /// allocation at runtime.
2184 ///
2185 /// This is similar to [`Config::memory_may_move`] but applies to the GC
2186 /// heap rather than to linear memories. See that method for more details.
2187 ///
2188 /// ## Default
2189 ///
2190 /// If none of the `gc_heap_*` tunables are explicitly configured, they
2191 /// default to the same values as their `memory_*` counterparts. Otherwise,
2192 /// the default value for this option is `true`.
2193 pub fn gc_heap_may_move(&mut self, enable: bool) -> &mut Self {
2194 self.tunables.gc_heap_may_move = Some(enable);
2195 self
2196 }
2197
2198 /// Indicates whether a guard region is present before allocations of
2199 /// linear memory.
2200 ///
2201 /// Guard regions before linear memories are never used during normal
2202 /// operation of WebAssembly modules, even if they have out-of-bounds
2203 /// loads. The only purpose for a preceding guard region in linear memory
2204 /// is extra protection against possible bugs in code generators like
2205 /// Cranelift. This setting does not affect performance in any way, but will
2206 /// result in larger virtual memory reservations for linear memories (it
2207 /// won't actually ever use more memory, just use more of the address
2208 /// space).
2209 ///
2210 /// The size of the guard region before linear memory is the same as the
2211 /// guard size that comes after linear memory, which is configured by
2212 /// [`Config::memory_guard_size`].
2213 ///
2214 /// ## Default
2215 ///
2216 /// This value defaults to `true`.
2217 pub fn guard_before_linear_memory(&mut self, enable: bool) -> &mut Self {
2218 self.tunables.guard_before_linear_memory = Some(enable);
2219 self
2220 }
2221
2222 /// Indicates whether to initialize tables lazily, so that instantiation
2223 /// is fast but indirect calls are a little slower. If false, tables
2224 /// are initialized eagerly during instantiation from any active element
2225 /// segments that apply to them.
2226 ///
2227 /// **Note** Disabling this option is not compatible with the Winch compiler.
2228 ///
2229 /// ## Default
2230 ///
2231 /// This value defaults to `true`.
2232 pub fn table_lazy_init(&mut self, table_lazy_init: bool) -> &mut Self {
2233 self.tunables.table_lazy_init = Some(table_lazy_init);
2234 self
2235 }
2236
2237 /// Configure the version information used in serialized and deserialized [`crate::Module`]s.
2238 /// This effects the behavior of [`crate::Module::serialize()`], as well as
2239 /// [`crate::Module::deserialize()`] and related functions.
2240 ///
2241 /// The default strategy is to use the wasmtime crate's Cargo package version.
2242 pub fn module_version(&mut self, strategy: ModuleVersionStrategy) -> Result<&mut Self> {
2243 match strategy {
2244 // This case requires special precondition for assertion in SerializedModule::to_bytes
2245 ModuleVersionStrategy::Custom(ref v) => {
2246 if v.as_bytes().len() > 255 {
2247 bail!("custom module version cannot be more than 255 bytes: {v}");
2248 }
2249 }
2250 _ => {}
2251 }
2252 self.module_version = strategy;
2253 Ok(self)
2254 }
2255
2256 /// Configure whether wasmtime should compile a module using multiple
2257 /// threads.
2258 ///
2259 /// Disabling this will result in a single thread being used to compile
2260 /// the wasm bytecode.
2261 ///
2262 /// By default parallel compilation is enabled.
2263 #[cfg(feature = "parallel-compilation")]
2264 pub fn parallel_compilation(&mut self, parallel: bool) -> &mut Self {
2265 self.parallel_compilation = parallel;
2266 self
2267 }
2268
2269 /// Configures whether compiled artifacts will contain information to map
2270 /// native program addresses back to the original wasm module.
2271 ///
2272 /// This configuration option is `true` by default and, if enabled,
2273 /// generates the appropriate tables in compiled modules to map from native
2274 /// address back to wasm source addresses. This is used for displaying wasm
2275 /// program counters in backtraces as well as generating filenames/line
2276 /// numbers if so configured as well (and the original wasm module has DWARF
2277 /// debugging information present).
2278 pub fn generate_address_map(&mut self, generate: bool) -> &mut Self {
2279 self.tunables.generate_address_map = Some(generate);
2280 self
2281 }
2282
2283 /// Configures whether copy-on-write memory-mapped data is used to
2284 /// initialize a linear memory.
2285 ///
2286 /// Initializing linear memory via a copy-on-write mapping can drastically
2287 /// improve instantiation costs of a WebAssembly module because copying
2288 /// memory is deferred. Additionally if a page of memory is only ever read
2289 /// from WebAssembly and never written too then the same underlying page of
2290 /// data will be reused between all instantiations of a module meaning that
2291 /// if a module is instantiated many times this can lower the overall memory
2292 /// required needed to run that module.
2293 ///
2294 /// The main disadvantage of copy-on-write initialization, however, is that
2295 /// it may be possible for highly-parallel scenarios to be less scalable. If
2296 /// a page is read initially by a WebAssembly module then that page will be
2297 /// mapped to a read-only copy shared between all WebAssembly instances. If
2298 /// the same page is then written, however, then a private copy is created
2299 /// and swapped out from the read-only version. This also requires an [IPI],
2300 /// however, which can be a significant bottleneck in high-parallelism
2301 /// situations.
2302 ///
2303 /// This feature is only applicable when a WebAssembly module meets specific
2304 /// criteria to be initialized in this fashion, such as:
2305 ///
2306 /// * Only memories defined in the module can be initialized this way.
2307 /// * Data segments for memory must use statically known offsets.
2308 /// * Data segments for memory must all be in-bounds.
2309 ///
2310 /// Modules which do not meet these criteria will fall back to
2311 /// initialization of linear memory based on copying memory.
2312 ///
2313 /// This feature of Wasmtime is also platform-specific:
2314 ///
2315 /// * Linux - this feature is supported for all instances of [`Module`].
2316 /// Modules backed by an existing mmap (such as those created by
2317 /// [`Module::deserialize_file`]) will reuse that mmap to cow-initialize
2318 /// memory. Other instance of [`Module`] may use the `memfd_create`
2319 /// syscall to create an initialization image to `mmap`.
2320 /// * Unix (not Linux) - this feature is only supported when loading modules
2321 /// from a precompiled file via [`Module::deserialize_file`] where there
2322 /// is a file descriptor to use to map data into the process. Note that
2323 /// the module must have been compiled with this setting enabled as well.
2324 /// * Windows - there is no support for this feature at this time. Memory
2325 /// initialization will always copy bytes.
2326 ///
2327 /// By default this option is enabled.
2328 ///
2329 /// [`Module::deserialize_file`]: crate::Module::deserialize_file
2330 /// [`Module`]: crate::Module
2331 /// [IPI]: https://en.wikipedia.org/wiki/Inter-processor_interrupt
2332 pub fn memory_init_cow(&mut self, enable: bool) -> &mut Self {
2333 self.tunables.memory_init_cow = Some(enable);
2334 self
2335 }
2336
2337 /// A configuration option to force the usage of `memfd_create` on Linux to
2338 /// be used as the backing source for a module's initial memory image.
2339 ///
2340 /// When [`Config::memory_init_cow`] is enabled, which is enabled by
2341 /// default, module memory initialization images are taken from a module's
2342 /// original mmap if possible. If a precompiled module was loaded from disk
2343 /// this means that the disk's file is used as an mmap source for the
2344 /// initial linear memory contents. This option can be used to force, on
2345 /// Linux, that instead of using the original file on disk a new in-memory
2346 /// file is created with `memfd_create` to hold the contents of the initial
2347 /// image.
2348 ///
2349 /// This option can be used to avoid possibly loading the contents of memory
2350 /// from disk through a page fault. Instead with `memfd_create` the contents
2351 /// of memory are always in RAM, meaning that even page faults which
2352 /// initially populate a wasm linear memory will only work with RAM instead
2353 /// of ever hitting the disk that the original precompiled module is stored
2354 /// on.
2355 ///
2356 /// This option is disabled by default.
2357 pub fn force_memory_init_memfd(&mut self, enable: bool) -> &mut Self {
2358 self.force_memory_init_memfd = enable;
2359 self
2360 }
2361
2362 /// Configures whether or not a coredump should be generated and attached to
2363 /// the [`Error`](crate::Error) when a trap is raised.
2364 ///
2365 /// This option is disabled by default.
2366 #[cfg(feature = "coredump")]
2367 pub fn coredump_on_trap(&mut self, enable: bool) -> &mut Self {
2368 self.coredump_on_trap = enable;
2369 self
2370 }
2371
2372 /// Enables memory error checking for wasm programs.
2373 ///
2374 /// This option is disabled by default.
2375 ///
2376 /// # Panics
2377 ///
2378 /// Panics if this configuration's compiler was [disabled][Config::enable_compiler].
2379 #[cfg(any(feature = "cranelift", feature = "winch"))]
2380 pub fn wmemcheck(&mut self, enable: bool) -> &mut Self {
2381 self.wmemcheck = enable;
2382 self.compiler_config_mut().wmemcheck = enable;
2383 self
2384 }
2385
2386 /// Configures the "guaranteed dense image size" for copy-on-write
2387 /// initialized memories.
2388 ///
2389 /// When using the [`Config::memory_init_cow`] feature to initialize memory
2390 /// efficiently (which is enabled by default), compiled modules contain an
2391 /// image of the module's initial heap. If the module has a fairly sparse
2392 /// initial heap, with just a few data segments at very different offsets,
2393 /// this could result in a large region of zero bytes in the image. In
2394 /// other words, it's not very memory-efficient.
2395 ///
2396 /// We normally use a heuristic to avoid this: if less than half
2397 /// of the initialized range (first non-zero to last non-zero
2398 /// byte) of any memory in the module has pages with nonzero
2399 /// bytes, then we avoid creating a memory image for the entire module.
2400 ///
2401 /// However, if the embedder always needs the instantiation-time efficiency
2402 /// of copy-on-write initialization, and is otherwise carefully controlling
2403 /// parameters of the modules (for example, by limiting the maximum heap
2404 /// size of the modules), then it may be desirable to ensure a memory image
2405 /// is created even if this could go against the heuristic above. Thus, we
2406 /// add another condition: there is a size of initialized data region up to
2407 /// which we *always* allow a memory image. The embedder can set this to a
2408 /// known maximum heap size if they desire to always get the benefits of
2409 /// copy-on-write images.
2410 ///
2411 /// In the future we may implement a "best of both worlds"
2412 /// solution where we have a dense image up to some limit, and
2413 /// then support a sparse list of initializers beyond that; this
2414 /// would get most of the benefit of copy-on-write and pay the incremental
2415 /// cost of eager initialization only for those bits of memory
2416 /// that are out-of-bounds. However, for now, an embedder desiring
2417 /// fast instantiation should ensure that this setting is as large
2418 /// as the maximum module initial memory content size.
2419 ///
2420 /// By default this value is 16 MiB.
2421 pub fn memory_guaranteed_dense_image_size(&mut self, size_in_bytes: u64) -> &mut Self {
2422 self.memory_guaranteed_dense_image_size = size_in_bytes;
2423 self
2424 }
2425
2426 /// Whether to enable function inlining during compilation or not.
2427 ///
2428 /// This may result in faster execution at runtime, but adds additional
2429 /// compilation time. Inlining may also enlarge the size of compiled
2430 /// artifacts (for example, the size of the result of
2431 /// [`Engine::precompile_component`]).
2432 ///
2433 /// Inlining is not supported by all of Wasmtime's compilation strategies;
2434 /// currently, it only Cranelift supports it. This setting will be ignored
2435 /// when using a compilation strategy that does not support inlining, like
2436 /// Winch.
2437 ///
2438 /// The default value for this is `Inlining::No`.
2439 pub fn compiler_inlining(&mut self, inlining: Inlining) -> &mut Self {
2440 self.tunables.inlining = Some(inlining);
2441 self
2442 }
2443
2444 /// Returns the set of features that the currently selected compiler backend
2445 /// does not support at all and may panic on.
2446 ///
2447 /// Wasmtime strives to reject unknown modules or unsupported modules with
2448 /// first-class errors instead of panics. Not all compiler backends have the
2449 /// same level of feature support on all platforms as well. This method
2450 /// returns a set of features that the currently selected compiler
2451 /// configuration is known to not support and may panic on. This acts as a
2452 /// first-level filter on incoming wasm modules/configuration to fail-fast
2453 /// instead of panicking later on.
2454 ///
2455 /// Note that if a feature is not returned here it does not mean that the
2456 /// backend fully supports the proposal. Instead that means that the backend
2457 /// doesn't ever panic on the proposal, but errors during compilation may
2458 /// still be returned. This means that features listed here are definitely
2459 /// not supported at all, but features not listed here may still be
2460 /// partially supported. For example at the time of this writing the Winch
2461 /// backend partially supports simd so it's not listed here. Winch doesn't
2462 /// fully support simd but unimplemented instructions just return errors.
2463 fn compiler_panicking_wasm_features(&self) -> WasmFeatures {
2464 // First we compute the set of features that Wasmtime itself knows;
2465 // this is a sort of "maximal set" that we invert to create a set
2466 // of features we _definitely can't support_ because wasmtime
2467 // has never heard of them.
2468 let features_known_to_wasmtime = WasmFeatures::WASM3
2469 | WasmFeatures::SHARED_EVERYTHING_THREADS
2470 | WasmFeatures::COMPONENT_MODEL
2471 | WasmFeatures::CUSTOM_PAGE_SIZES
2472 | WasmFeatures::COMPACT_IMPORTS
2473 | WasmFeatures::STACK_SWITCHING
2474 | WasmFeatures::WIDE_ARITHMETIC
2475 | WasmFeatures::CM_ASYNC
2476 | WasmFeatures::CM_ASYNC_STACKFUL
2477 | WasmFeatures::CM_MORE_ASYNC_BUILTINS
2478 | WasmFeatures::CM_THREADING
2479 | WasmFeatures::CM_ERROR_CONTEXT
2480 | WasmFeatures::CM_GC
2481 | WasmFeatures::CM_MAP
2482 | WasmFeatures::CM64
2483 | WasmFeatures::CM_FIXED_LENGTH_LISTS
2484 | WasmFeatures::CM_IMPLEMENTS
2485 | WasmFeatures::CM_CANON_NAMES
2486 | WasmFeatures::CM_ACCESSORS;
2487
2488 let mut unsupported = !features_known_to_wasmtime;
2489
2490 match self.get_strategy() {
2491 None | Some(Strategy::Cranelift) => {
2492 // Pulley at this time fundamentally doesn't support the
2493 // `threads` proposal, notably shared memory, because Rust can't
2494 // safely implement loads/stores in the face of shared memory.
2495 // Stack switching is not implemented, either.
2496 if self.compiler_target().is_pulley() {
2497 unsupported |= WasmFeatures::THREADS;
2498 unsupported |= WasmFeatures::STACK_SWITCHING;
2499 }
2500
2501 use target_lexicon::*;
2502 match self.compiler_target() {
2503 Triple {
2504 architecture: Architecture::X86_64 | Architecture::X86_64h,
2505 operating_system:
2506 OperatingSystem::Linux
2507 | OperatingSystem::MacOSX(_)
2508 | OperatingSystem::Darwin(_),
2509 ..
2510 } => {
2511 // Stack switching supported on (non-Pulley) Cranelift.
2512 }
2513
2514 _ => {
2515 // On platforms other than x64 Unix-like, we don't
2516 // support stack switching.
2517 unsupported |= WasmFeatures::STACK_SWITCHING;
2518 }
2519 }
2520 }
2521 Some(Strategy::Winch) => {
2522 unsupported |= WasmFeatures::GC
2523 | WasmFeatures::FUNCTION_REFERENCES
2524 | WasmFeatures::RELAXED_SIMD
2525 | WasmFeatures::LEGACY_EXCEPTIONS
2526 | WasmFeatures::STACK_SWITCHING;
2527
2528 match self.compiler_target().architecture {
2529 target_lexicon::Architecture::Aarch64(_) => {
2530 unsupported |= WasmFeatures::THREADS;
2531 }
2532
2533 // Winch doesn't support other non-x64 architectures at this
2534 // time either but will return an first-class error for
2535 // them.
2536 _ => {}
2537 }
2538 }
2539 Some(Strategy::Auto) => unreachable!(),
2540 }
2541 unsupported
2542 }
2543
2544 fn get_strategy(&self) -> Option<Strategy> {
2545 #[cfg(any(feature = "cranelift", feature = "winch"))]
2546 return self.compiler_config.as_ref()?.strategy;
2547 #[cfg(not(any(feature = "cranelift", feature = "winch")))]
2548 return None;
2549 }
2550
2551 /// Calculates the set of features that are enabled for this `Config`.
2552 ///
2553 /// This is a bit of a subtle function which takes into account inputs such
2554 /// as the default set of features Wasmtime has enabled, the currently
2555 /// enabled compiler, the currently enabled target, compile-time crate
2556 /// features, and explicitly configured wasm proposals. This function does
2557 /// not return a fixed set of all proposals in all cases as it's a bit more
2558 /// nuanced than that.
2559 ///
2560 /// This method internally will start with an empty set of features to
2561 /// avoid being tied to wasmparser's defaults. Next Wasmtime's set of
2562 /// default features are added to this set, some of which are conditional
2563 /// depending on crate features. Finally explicitly requested features via
2564 /// `wasm_*` methods on `Config` are applied. Everything is then validated
2565 /// later in `Config::validate`.
2566 ///
2567 /// Note that the validation later on in `Config::validate` is a crucial
2568 /// step here. The returned features here might include features unsupported
2569 /// at compile time or unsupported by the selected compiler. In that case
2570 /// `Config::validate` will present a first-class error message indicating
2571 /// what's going on, and users should in theory be able to understand "ok
2572 /// yeah that's why I can't enable that feature here".
2573 fn features(&self) -> WasmFeatures {
2574 let mut features;
2575
2576 // Next add in all on-by-default features that Wasmtime has which are
2577 // subject to the criteria at
2578 // https://docs.wasmtime.dev/contributing-implementing-wasm-proposals.html
2579 // and https://docs.wasmtime.dev/stability-wasm-proposals.html.
2580 //
2581 // Features here are based on the currently selected compiler. Wasm
2582 // features generally are tightly intertwined with compiler support, and
2583 // just because we want to on-by-default support in one compiler doesn't
2584 // mean we want it for another. Additionally note that each compiler
2585 // here starts with a fixed, unchanging, set of wasm features (e.g.
2586 // `WASM2` or `WASM3`) which insulates this from `wasmparser`'s
2587 // defaults.
2588 //
2589 // Finally, `None` is possible here when compiler support isn't enabled
2590 // at all. In that situation just assume we're using Cranelift's feature
2591 // set.
2592 //
2593 // NB: if you add a feature to a compiler please double-check
2594 // https://docs.wasmtime.dev/stability-wasm-proposals.html
2595 // to ensure all requirements are met and/or update the documentation
2596 // there too.
2597 match self.get_strategy() {
2598 None | Some(Strategy::Cranelift) => {
2599 features = WasmFeatures::WASM3;
2600 features |= WasmFeatures::WIDE_ARITHMETIC;
2601
2602 // features |= WasmFeatures::YOUR_WASM_FEATURE;
2603 // ...
2604 }
2605 Some(Strategy::Winch) => {
2606 features = WasmFeatures::WASM2;
2607 features.remove(WasmFeatures::GC_TYPES);
2608 features |= WasmFeatures::EXTENDED_CONST;
2609 features |= WasmFeatures::MEMORY64;
2610 features |= WasmFeatures::MULTI_MEMORY;
2611 }
2612 Some(Strategy::Auto) => unreachable!(),
2613 }
2614
2615 // Next configure some features further based on compile-time features
2616 // of the wasmtime crate itself. For example if "gc" is disabled then
2617 // `GC_TYPES` are disabled (a wasmparser pseudo-feature) as well as
2618 // exceptions, but reference-types is still available (e.g. new
2619 // encodings/types/etc).
2620 if !cfg!(feature = "gc") {
2621 features.remove(WasmFeatures::GC_TYPES | WasmFeatures::EXCEPTIONS);
2622 }
2623 if !cfg!(feature = "threads") {
2624 features.remove(WasmFeatures::THREADS);
2625 }
2626
2627 // These features aren't included in the base sets above, so explicitly
2628 // enable/disable them there based on compiler features. Note that
2629 // these are pretty much exclusively runtime-related features so there's
2630 // no differentiation here between compilers.
2631 features.set(
2632 WasmFeatures::COMPONENT_MODEL,
2633 cfg!(feature = "component-model"),
2634 );
2635 features.set(
2636 WasmFeatures::CM_ASYNC,
2637 self.tunables
2638 .concurrency_support
2639 .unwrap_or(cfg!(feature = "component-model-async")),
2640 );
2641
2642 // Next disable any features which the current compiler/target do not
2643 // support. This handles cases where Winch, for example, doesn't
2644 // implement a feature yet but Cranelift does. Or maybe Cranelift only
2645 // supports one particular platform and not others. Things like that.
2646 features = features & !self.compiler_panicking_wasm_features();
2647
2648 // And, finally, process all explicitly enabled/disabled features on
2649 // behalf of the embedder's frobbing `Config::wasm_*`. These have the
2650 // highest priority since they were explicitly requested.
2651 debug_assert!((self.enabled_features & self.disabled_features).is_empty());
2652 features &= !self.disabled_features;
2653 features |= self.enabled_features;
2654
2655 features
2656 }
2657
2658 /// Returns the configured compiler target for this `Config`.
2659 pub(crate) fn compiler_target(&self) -> target_lexicon::Triple {
2660 // If a target is explicitly configured, always use that.
2661 if let Some(target) = self.target.clone() {
2662 return target;
2663 }
2664
2665 // If the `build.rs` script determined that this platform uses pulley by
2666 // default, then use Pulley.
2667 if cfg!(default_target_pulley) {
2668 return target_lexicon::Triple::pulley_host();
2669 }
2670
2671 // And at this point the target is for sure the host.
2672 target_lexicon::Triple::host()
2673 }
2674
2675 /// Returns `true` if any of the `gc_heap_*` tunables have been explicitly
2676 /// configured.
2677 fn any_gc_heap_tunables_configured(&self) -> bool {
2678 self.tunables.gc_heap_reservation.is_some()
2679 || self.tunables.gc_heap_guard_size.is_some()
2680 || self.tunables.gc_heap_reservation_for_growth.is_some()
2681 || self.tunables.gc_heap_may_move.is_some()
2682 }
2683
2684 pub(crate) fn validate(&self) -> Result<(Tunables, WasmFeatures)> {
2685 let features = self.features();
2686
2687 // First validate that the selected compiler backend and configuration
2688 // supports the set of `features` that are enabled. This will help
2689 // provide more first class errors instead of panics about unsupported
2690 // features and configurations.
2691 let unsupported = features & self.compiler_panicking_wasm_features();
2692 if !unsupported.is_empty() {
2693 for flag in WasmFeatures::FLAGS.iter() {
2694 if !unsupported.contains(*flag.value()) {
2695 continue;
2696 }
2697 bail!(
2698 "the wasm_{} feature is not supported on this compiler configuration",
2699 flag.name().to_lowercase()
2700 );
2701 }
2702
2703 panic!("should have returned an error by now")
2704 }
2705
2706 if self.max_wasm_stack > self.async_stack_size {
2707 bail!("max_wasm_stack size cannot exceed the async_stack_size");
2708 }
2709 if self.max_wasm_stack == 0 {
2710 bail!("max_wasm_stack size cannot be zero");
2711 }
2712 if !cfg!(feature = "wmemcheck") && self.wmemcheck {
2713 bail!("wmemcheck (memory checker) was requested but is not enabled in this build");
2714 }
2715
2716 if !cfg!(feature = "gc") && features.gc_types() {
2717 bail!("support for GC was disabled at compile time")
2718 }
2719
2720 if !cfg!(feature = "gc") && features.contains(WasmFeatures::EXCEPTIONS) {
2721 bail!("exceptions support requires garbage collection (GC) to be enabled in the build");
2722 }
2723
2724 match &self.rr_config {
2725 #[cfg(feature = "rr")]
2726 RRConfig::Recording | RRConfig::Replaying => {
2727 self.validate_rr_determinism_conflicts()?;
2728 }
2729 RRConfig::None => {}
2730 };
2731
2732 let mut tunables = Tunables::default_for_target(&self.compiler_target())?;
2733
2734 // Stack switching is emitted inline in compiled Wasm. In
2735 // ASan-enabled builds the compiler must arrange the
2736 // corresponding fiber switch handshake around every such
2737 // instruction.
2738 tunables.asan_stack_switching = cfg!(asan);
2739
2740 // By default this is enabled with the Cargo feature, and if the feature
2741 // is missing this is disabled.
2742 tunables.concurrency_support = cfg!(feature = "component-model-async");
2743
2744 #[cfg(feature = "rr")]
2745 {
2746 tunables.recording = matches!(self.rr_config, RRConfig::Recording);
2747 }
2748
2749 // If no target is explicitly specified then further refine `tunables`
2750 // for the configuration of this host depending on what platform
2751 // features were found available at compile time. This means that anyone
2752 // cross-compiling for a customized host will need to further refine
2753 // compilation options.
2754 if self.target.is_none() {
2755 // If this platform doesn't have native signals then change some
2756 // defaults to account for that. Note that VM guards are turned off
2757 // here because that's primarily a feature of eliding
2758 // bounds-checks.
2759 if !cfg!(has_native_signals) {
2760 tunables.signals_based_traps = cfg!(has_native_signals);
2761 tunables.memory_guard_size = 0;
2762 tunables.gc_heap_guard_size = 0;
2763 }
2764
2765 // When virtual memory is not available use slightly different
2766 // defaults for tunables to be more amenable to `MallocMemory`.
2767 // Note that these can still be overridden by config options.
2768 if !cfg!(has_virtual_memory) {
2769 tunables.memory_reservation = 0;
2770 tunables.memory_reservation_for_growth = 1 << 20; // 1MB
2771 tunables.memory_init_cow = false;
2772 tunables.gc_heap_reservation = 0;
2773 tunables.gc_heap_reservation_for_growth = 1 << 20; // 1MB
2774 }
2775 }
2776
2777 // If guest-debugging is enabled, we must disable
2778 // signals-based traps. Do this before we process the user's
2779 // provided tunables settings so we can detect a conflict with
2780 // an explicit request to use signals-based traps.
2781 #[cfg(feature = "debug")]
2782 if self.tunables.debug_guest == Some(true) {
2783 tunables.signals_based_traps = false;
2784 }
2785
2786 // Inlining currently falls over with the `stack_switch` instruction.
2787 #[cfg(any(feature = "cranelift", feature = "winch"))]
2788 if features.contains(WasmFeatures::STACK_SWITCHING) {
2789 if let Some(inlining) = self.tunables.inlining
2790 && inlining != Inlining::No
2791 {
2792 bail!("cannot enable compiler inlining when stack switching is enabled");
2793 }
2794 tunables.inlining = Inlining::No;
2795 }
2796
2797 self.tunables.configure(&mut tunables);
2798
2799 // If no GC heap tunables are explicitly configured, copy the memory
2800 // tunables' configured values so that GC heaps default to the same
2801 // configuration as linear memories.
2802 if !self.any_gc_heap_tunables_configured() {
2803 tunables.gc_heap_reservation = tunables.memory_reservation;
2804 tunables.gc_heap_guard_size = tunables.memory_guard_size;
2805 tunables.gc_heap_reservation_for_growth = tunables.memory_reservation_for_growth;
2806 tunables.gc_heap_may_move = tunables.memory_may_move;
2807 }
2808
2809 // Validate that the configuration of reservation/guards is sensible
2810 // enough to ever possibly actually get allocated. If this overflows a
2811 // u64 then there's no hope.
2812 let guard_regions = if tunables.guard_before_linear_memory {
2813 2
2814 } else {
2815 1
2816 };
2817 for (what, reservation, guard_size) in [
2818 (
2819 "memory",
2820 tunables.memory_reservation,
2821 tunables.memory_guard_size,
2822 ),
2823 (
2824 "gc_heap",
2825 tunables.gc_heap_reservation,
2826 tunables.gc_heap_guard_size,
2827 ),
2828 ] {
2829 if guard_size
2830 .checked_mul(guard_regions)
2831 .and_then(|g| g.checked_add(reservation))
2832 .is_none()
2833 {
2834 bail!(
2835 "`{what}_reservation` ({reservation}) plus `{what}_guard_size` \
2836 ({guard_size}) overflows"
2837 );
2838 }
2839 }
2840
2841 // If we're going to compile with winch, we must use the winch calling convention.
2842 #[cfg(any(feature = "cranelift", feature = "winch"))]
2843 {
2844 tunables.winch_callable = self
2845 .compiler_config
2846 .as_ref()
2847 .is_some_and(|c| c.strategy == Some(Strategy::Winch));
2848 }
2849
2850 tunables.collector = if features.gc_types() {
2851 #[cfg(feature = "gc")]
2852 {
2853 use wasmtime_environ::Collector as EnvCollector;
2854 Some(match self.collector.try_not_auto()? {
2855 Collector::DeferredReferenceCounting => EnvCollector::DeferredReferenceCounting,
2856 Collector::Null => EnvCollector::Null,
2857 Collector::Copying => EnvCollector::Copying,
2858 Collector::Auto => unreachable!(),
2859 })
2860 }
2861 #[cfg(not(feature = "gc"))]
2862 bail!("cannot use GC types: the `gc` feature was disabled at compile time")
2863 } else {
2864 None
2865 };
2866
2867 if tunables.debug_guest {
2868 ensure!(
2869 cfg!(feature = "debug"),
2870 "debug instrumentation support was disabled at compile time"
2871 );
2872 ensure!(
2873 !tunables.signals_based_traps,
2874 "cannot use signals-based traps with guest debugging enabled"
2875 );
2876 }
2877
2878 // Concurrency support is required for some component model features.
2879 let requires_concurrency = WasmFeatures::CM_ASYNC
2880 | WasmFeatures::CM_MORE_ASYNC_BUILTINS
2881 | WasmFeatures::CM_ASYNC_STACKFUL
2882 | WasmFeatures::CM_THREADING
2883 | WasmFeatures::CM_ERROR_CONTEXT;
2884 if tunables.concurrency_support && !cfg!(feature = "component-model-async") {
2885 bail!(
2886 "concurrency support was requested but was not \
2887 compiled into this build of Wasmtime"
2888 )
2889 }
2890 if !tunables.concurrency_support && features.intersects(requires_concurrency) {
2891 bail!(
2892 "concurrency support must be enabled to use the component \
2893 model async or threading features"
2894 )
2895 }
2896
2897 // Generated adapters between components will use `ref.func` in some
2898 // async-related situations so `component-model-async` requires
2899 // `reference-types`.
2900 if features.contains(WasmFeatures::CM_ASYNC)
2901 && !features.contains(WasmFeatures::REFERENCE_TYPES)
2902 {
2903 bail!("the component-model-async feature requires the wasm reference-types proposal");
2904 }
2905
2906 // If the pooling allocator is used and GC is enabled, check that
2907 // memories and the GC heap are configured identically, since the
2908 // pooling allocator can't support differently-configured heaps.
2909 #[cfg(feature = "pooling-allocator")]
2910 if matches!(
2911 &self.allocation_strategy,
2912 InstanceAllocationStrategy::Pooling(_)
2913 ) && tunables.collector.is_some()
2914 {
2915 if tunables.memory_reservation != tunables.gc_heap_reservation {
2916 bail!(
2917 "when using the pooling allocator with GC, `memory_reservation` ({}) \
2918 and `gc_heap_reservation` ({}) must be the same",
2919 tunables.memory_reservation,
2920 tunables.gc_heap_reservation,
2921 );
2922 }
2923 if tunables.memory_guard_size != tunables.gc_heap_guard_size {
2924 bail!(
2925 "when using the pooling allocator with GC, `memory_guard_size` ({}) \
2926 and `gc_heap_guard_size` ({}) must be the same",
2927 tunables.memory_guard_size,
2928 tunables.gc_heap_guard_size,
2929 );
2930 }
2931 if tunables.memory_reservation_for_growth != tunables.gc_heap_reservation_for_growth {
2932 bail!(
2933 "when using the pooling allocator with GC, \
2934 `memory_reservation_for_growth` ({}) and \
2935 `gc_heap_reservation_for_growth` ({}) must be the same",
2936 tunables.memory_reservation_for_growth,
2937 tunables.gc_heap_reservation_for_growth,
2938 );
2939 }
2940 if tunables.memory_may_move != tunables.gc_heap_may_move {
2941 bail!(
2942 "when using the pooling allocator with GC, `memory_may_move` ({}) \
2943 and `gc_heap_may_move` ({}) must be the same",
2944 tunables.memory_may_move,
2945 tunables.gc_heap_may_move,
2946 );
2947 }
2948 }
2949
2950 if tunables.debug_native && !tunables.debug_symbols {
2951 bail!("cannot enable native debug info while debug symbols are disabled");
2952 }
2953
2954 Ok((tunables, features))
2955 }
2956
2957 #[cfg(feature = "runtime")]
2958 pub(crate) fn build_allocator(
2959 &self,
2960 tunables: &Tunables,
2961 ) -> Result<Box<dyn InstanceAllocator + Send + Sync>> {
2962 let _ = tunables;
2963
2964 match &self.allocation_strategy {
2965 InstanceAllocationStrategy::OnDemand => {
2966 let mut _allocator = try_new::<Box<_>>(OnDemandInstanceAllocator::new(
2967 self.mem_creator.clone(),
2968 self.async_stack_size,
2969 self.async_stack_zeroing,
2970 ))?;
2971 #[cfg(feature = "async")]
2972 if let Some(stack_creator) = &self.stack_creator {
2973 _allocator.set_stack_creator(stack_creator.clone());
2974 }
2975 Ok(_allocator as _)
2976 }
2977 #[cfg(feature = "pooling-allocator")]
2978 InstanceAllocationStrategy::Pooling(config) => {
2979 let mut config = config.clone();
2980 let _ = &mut config;
2981 #[cfg(feature = "async")]
2982 {
2983 config.stack_size = self.async_stack_size;
2984 config.async_stack_zeroing = self.async_stack_zeroing;
2985 }
2986 let allocator = try_new::<Box<_>>(
2987 crate::runtime::vm::PoolingInstanceAllocator::new(&config, tunables)?,
2988 )?;
2989 Ok(allocator as _)
2990 }
2991 }
2992 }
2993
2994 #[cfg(feature = "runtime")]
2995 pub(crate) fn build_gc_runtime(&self) -> Result<Option<Arc<dyn GcRuntime>>> {
2996 if !self.features().gc_types() {
2997 return Ok(None);
2998 }
2999
3000 #[cfg(not(feature = "gc"))]
3001 bail!("cannot create a GC runtime: the `gc` feature was disabled at compile time");
3002
3003 #[cfg(feature = "gc")]
3004 #[cfg_attr(
3005 not(any(feature = "gc-null", feature = "gc-drc", feature = "gc-copying")),
3006 expect(unreachable_code, reason = "definitions known to be dummy")
3007 )]
3008 {
3009 Ok(Some(match self.collector.try_not_auto()? {
3010 #[cfg(feature = "gc-drc")]
3011 Collector::DeferredReferenceCounting => {
3012 try_new::<Arc<_>>(crate::runtime::vm::DrcCollector::default())? as _
3013 }
3014 #[cfg(not(feature = "gc-drc"))]
3015 Collector::DeferredReferenceCounting => unreachable!(),
3016
3017 #[cfg(feature = "gc-null")]
3018 Collector::Null => {
3019 try_new::<Arc<_>>(crate::runtime::vm::NullCollector::default())? as _
3020 }
3021 #[cfg(not(feature = "gc-null"))]
3022 Collector::Null => unreachable!(),
3023
3024 #[cfg(feature = "gc-copying")]
3025 Collector::Copying => {
3026 try_new::<Arc<_>>(crate::runtime::vm::CopyingCollector::default())? as _
3027 }
3028 #[cfg(not(feature = "gc-copying"))]
3029 Collector::Copying => unreachable!(),
3030
3031 Collector::Auto => unreachable!(),
3032 }))
3033 }
3034 }
3035
3036 #[cfg(feature = "runtime")]
3037 pub(crate) fn build_profiler(&self) -> Result<Box<dyn ProfilingAgent>> {
3038 Ok(match self.profiling_strategy {
3039 ProfilingStrategy::PerfMap => profiling_agent::new_perfmap()?,
3040 ProfilingStrategy::JitDump => profiling_agent::new_jitdump()?,
3041 ProfilingStrategy::VTune => profiling_agent::new_vtune()?,
3042 ProfilingStrategy::None => profiling_agent::new_null(),
3043 ProfilingStrategy::Pulley => profiling_agent::new_pulley()?,
3044 })
3045 }
3046
3047 #[cfg(any(feature = "cranelift", feature = "winch"))]
3048 pub(crate) fn build_compiler(
3049 mut self,
3050 tunables: &mut Tunables,
3051 features: WasmFeatures,
3052 ) -> Result<(Self, Box<dyn wasmtime_environ::Compiler>)> {
3053 let target = self.compiler_target();
3054
3055 // The target passed to the builders below is an `Option<Triple>` where
3056 // `None` represents the current host with CPU features inferred from
3057 // the host's CPU itself. The `target` above is not an `Option`, so
3058 // switch it to `None` in the case that a target wasn't explicitly
3059 // specified (which indicates no feature inference) and the target
3060 // matches the host.
3061 let target_for_builder =
3062 if self.target.is_none() && target == target_lexicon::Triple::host() {
3063 None
3064 } else {
3065 Some(target.clone())
3066 };
3067
3068 let mut compiler = match self.compiler_config_mut().strategy {
3069 #[cfg(feature = "cranelift")]
3070 Some(Strategy::Cranelift) => wasmtime_cranelift::builder(target_for_builder)?,
3071 #[cfg(not(feature = "cranelift"))]
3072 Some(Strategy::Cranelift) => bail!("cranelift support not compiled in"),
3073 #[cfg(feature = "winch")]
3074 Some(Strategy::Winch) => wasmtime_winch::builder(target_for_builder)?,
3075 #[cfg(not(feature = "winch"))]
3076 Some(Strategy::Winch) => bail!("winch support not compiled in"),
3077
3078 None | Some(Strategy::Auto) => unreachable!(),
3079 };
3080
3081 if let Some(path) = &self.compiler_config_mut().clif_dir {
3082 compiler.clif_dir(path)?;
3083 }
3084
3085 // If probestack is enabled for a target, Wasmtime will always use the
3086 // inline strategy which doesn't require us to define a `__probestack`
3087 // function or similar.
3088 self.compiler_config_mut().settings.insert(
3089 "probestack_strategy".into(),
3090 ("inline".into(), UserSpecified::No),
3091 );
3092
3093 // We enable stack probing by default on all targets.
3094 // This is required on Windows because of the way Windows
3095 // commits its stacks, but it's also a good idea on other
3096 // platforms to ensure guard pages are hit for large frame
3097 // sizes.
3098 self.compiler_config_mut()
3099 .flags
3100 .insert("enable_probestack".into(), UserSpecified::No);
3101
3102 // The current wasm multivalue implementation depends on this.
3103 // FIXME(#9510) handle this in wasmtime-cranelift instead.
3104 self.compiler_config_mut()
3105 .flags
3106 .insert("enable_multi_ret_implicit_sret".into(), UserSpecified::No);
3107
3108 if let Some(unwind_requested) = self.native_unwind_info {
3109 if !self
3110 .compiler_config_mut()
3111 .ensure_setting_unset_or_given("unwind_info", &unwind_requested.to_string())
3112 {
3113 bail!(
3114 "incompatible settings requested for Cranelift and Wasmtime `unwind-info` settings"
3115 );
3116 }
3117 }
3118
3119 if target.operating_system == target_lexicon::OperatingSystem::Windows {
3120 if !self
3121 .compiler_config_mut()
3122 .ensure_setting_unset_or_given("unwind_info", "true")
3123 {
3124 bail!("`native_unwind_info` cannot be disabled on Windows");
3125 }
3126 }
3127
3128 // We require frame pointers for correct stack walking, which is safety
3129 // critical in the presence of reference types, and otherwise it is just
3130 // really bad developer experience to get wrong.
3131 self.compiler_config_mut().settings.insert(
3132 "preserve_frame_pointers".into(),
3133 ("true".into(), UserSpecified::No),
3134 );
3135
3136 if !tunables.signals_based_traps {
3137 let mut ok = self
3138 .compiler_config_mut()
3139 .ensure_setting_unset_or_given("enable_table_access_spectre_mitigation", "false");
3140 ok = ok
3141 && self.compiler_config_mut().ensure_setting_unset_or_given(
3142 "enable_heap_access_spectre_mitigation",
3143 "false",
3144 );
3145
3146 // Right now spectre-mitigated bounds checks will load from zero so
3147 // if host-based signal handlers are disabled then that's a mismatch
3148 // and doesn't work right now. Fixing this will require more thought
3149 // of how to implement the bounds check in spectre-only mode.
3150 if !ok {
3151 bail!(
3152 "when signals-based traps are disabled then spectre \
3153 mitigations must also be disabled"
3154 );
3155 }
3156 }
3157
3158 if features.contains(WasmFeatures::RELAXED_SIMD) && !features.contains(WasmFeatures::SIMD) {
3159 bail!("cannot disable the simd proposal but enable the relaxed simd proposal");
3160 }
3161
3162 if features.contains(WasmFeatures::STACK_SWITCHING) {
3163 use target_lexicon::OperatingSystem;
3164 let model = match target.operating_system {
3165 OperatingSystem::Windows => "update_windows_tib",
3166 OperatingSystem::Linux
3167 | OperatingSystem::MacOSX(_)
3168 | OperatingSystem::Darwin(_) => "basic",
3169 _ => bail!("stack-switching feature not supported on this platform "),
3170 };
3171
3172 if !self
3173 .compiler_config_mut()
3174 .ensure_setting_unset_or_given("stack_switch_model", model)
3175 {
3176 bail!(
3177 "compiler option 'stack_switch_model' must be set to '{model}' on this platform"
3178 );
3179 }
3180 }
3181
3182 // Apply compiler settings and flags
3183 compiler.set_tunables(tunables.clone())?;
3184 for (k, (v, _)) in self.compiler_config_mut().settings.iter() {
3185 compiler.set(k, v)?;
3186 }
3187 for (flag, _) in self.compiler_config_mut().flags.iter() {
3188 compiler.enable(flag)?;
3189 }
3190 *tunables = compiler.tunables().cloned().unwrap();
3191
3192 #[cfg(all(feature = "incremental-cache", feature = "cranelift"))]
3193 if let Some(cache_store) = &self.compiler_config_mut().cache_store {
3194 compiler.enable_incremental_compilation(cache_store.clone())?;
3195 }
3196
3197 compiler.wmemcheck(self.compiler_config_mut().wmemcheck);
3198
3199 Ok((self, compiler.build()?))
3200 }
3201
3202 /// Internal setting for whether adapter modules for components will have
3203 /// extra WebAssembly instructions inserted performing more debug checks
3204 /// then are necessary.
3205 #[cfg(feature = "component-model")]
3206 pub fn debug_adapter_modules(&mut self, debug: bool) -> &mut Self {
3207 self.tunables.debug_adapter_modules = Some(debug);
3208 self
3209 }
3210
3211 /// Enables clif output when compiling a WebAssembly module.
3212 #[cfg(any(feature = "cranelift", feature = "winch"))]
3213 pub fn emit_clif(&mut self, path: &Path) -> &mut Self {
3214 self.compiler_config_mut().clif_dir = Some(path.to_path_buf());
3215 self
3216 }
3217
3218 /// Configures whether, when on macOS, Mach ports are used for exception
3219 /// handling instead of traditional Unix-based signal handling.
3220 ///
3221 /// WebAssembly traps in Wasmtime are implemented with native faults, for
3222 /// example a `SIGSEGV` will occur when a WebAssembly guest accesses
3223 /// out-of-bounds memory. Handling this can be configured to either use Unix
3224 /// signals or Mach ports on macOS. By default Mach ports are used.
3225 ///
3226 /// Mach ports enable Wasmtime to work by default with foreign
3227 /// error-handling systems such as breakpad which also use Mach ports to
3228 /// handle signals. In this situation Wasmtime will continue to handle guest
3229 /// faults gracefully while any non-guest faults will get forwarded to
3230 /// process-level handlers such as breakpad. Some more background on this
3231 /// can be found in #2456.
3232 ///
3233 /// A downside of using mach ports, however, is that they don't interact
3234 /// well with `fork()`. Forking a Wasmtime process on macOS will produce a
3235 /// child process that cannot successfully run WebAssembly. In this
3236 /// situation traditional Unix signal handling should be used as that's
3237 /// inherited and works across forks.
3238 ///
3239 /// If your embedding wants to use a custom error handler which leverages
3240 /// Mach ports and you additionally wish to `fork()` the process and use
3241 /// Wasmtime in the child process that's not currently possible. Please
3242 /// reach out to us if you're in this bucket!
3243 ///
3244 /// This option defaults to `true`, using Mach ports by default.
3245 pub fn macos_use_mach_ports(&mut self, mach_ports: bool) -> &mut Self {
3246 self.macos_use_mach_ports = mach_ports;
3247 self
3248 }
3249
3250 /// Configures an embedder-provided function, `detect`, which is used to
3251 /// determine if an ISA-specific feature is available on the current host.
3252 ///
3253 /// This function is used to verify that any features enabled for a compiler
3254 /// backend, such as AVX support on x86\_64, are also available on the host.
3255 /// It is undefined behavior to execute an AVX instruction on a host that
3256 /// doesn't support AVX instructions, for example.
3257 ///
3258 /// When the `std` feature is active on this crate then this function is
3259 /// configured to a default implementation that uses the standard library's
3260 /// feature detection. When the `std` feature is disabled then there is no
3261 /// default available and this method must be called to configure a feature
3262 /// probing function.
3263 ///
3264 /// The `detect` function provided is given a string name of an ISA feature.
3265 /// The function should then return:
3266 ///
3267 /// * `Some(true)` - indicates that the feature was found on the host and it
3268 /// is supported.
3269 /// * `Some(false)` - the feature name was recognized but it was not
3270 /// detected on the host, for example the CPU is too old.
3271 /// * `None` - the feature name was not recognized and it's not known
3272 /// whether it's on the host or not.
3273 ///
3274 /// Feature names passed to `detect` match the same feature name used in the
3275 /// Rust standard library. For example `"sse4.2"` is used on x86\_64.
3276 ///
3277 /// # Unsafety
3278 ///
3279 /// This function is `unsafe` because it is undefined behavior to execute
3280 /// instructions that a host does not support. This means that the result of
3281 /// `detect` must be correct for memory safe execution at runtime.
3282 pub unsafe fn detect_host_feature(&mut self, detect: fn(&str) -> Option<bool>) -> &mut Self {
3283 self.detect_host_feature = Some(detect);
3284 self
3285 }
3286
3287 /// Configures Wasmtime to not use signals-based trap handlers, for example
3288 /// disables `SIGILL` and `SIGSEGV` handler registration on Unix platforms.
3289 ///
3290 /// > **Note:** this option has important performance ramifications, be sure
3291 /// > to understand the implications. Wasm programs have been measured to
3292 /// > run up to 2x slower when signals-based traps are disabled.
3293 ///
3294 /// Wasmtime will by default leverage signals-based trap handlers (or the
3295 /// platform equivalent, for example "vectored exception handlers" on
3296 /// Windows) to make generated code more efficient. For example, when
3297 /// Wasmtime can use signals-based traps, it can elide explicit bounds
3298 /// checks for Wasm linear memory accesses, instead relying on virtual
3299 /// memory guard pages to raise a `SIGSEGV` (on Unix) for out-of-bounds
3300 /// accesses, which Wasmtime's runtime then catches and handles. Another
3301 /// example is divide-by-zero: with signals-based traps, Wasmtime can let
3302 /// the hardware raise a trap when the divisor is zero. Without
3303 /// signals-based traps, Wasmtime must explicitly emit additional
3304 /// instructions to check for zero and conditionally branch to a trapping
3305 /// code path.
3306 ///
3307 /// Some environments however may not have access to signal handlers. For
3308 /// example embedded scenarios may not support virtual memory. Other
3309 /// environments where Wasmtime is embedded within the surrounding
3310 /// environment may require that new signal handlers aren't registered due
3311 /// to the global nature of signal handlers. This option exists to disable
3312 /// the signal handler registration when required for these scenarios.
3313 ///
3314 /// When signals-based trap handlers are disabled, then Wasmtime and its
3315 /// generated code will *never* rely on segfaults or other
3316 /// signals. Generated code will be slower because bounds must be explicitly
3317 /// checked along with other conditions like division by zero.
3318 ///
3319 /// The following additional factors can also affect Wasmtime's ability to
3320 /// elide explicit bounds checks and leverage signals-based traps:
3321 ///
3322 /// * The [`Config::memory_reservation`] and [`Config::memory_guard_size`]
3323 /// settings
3324 /// * The index type of the linear memory (e.g. 32-bit or 64-bit)
3325 /// * The page size of the linear memory
3326 ///
3327 /// When this option is disabled, the
3328 /// `enable_heap_access_spectre_mitigation` and
3329 /// `enable_table_access_spectre_mitigation` Cranelift settings must also be
3330 /// disabled. This means that generated code must have spectre mitigations
3331 /// disabled. This is because spectre mitigations rely on faults from
3332 /// loading from the null address to implement bounds checks.
3333 ///
3334 /// This option defaults to `true`: signals-based trap handlers are enabled
3335 /// by default.
3336 ///
3337 /// > **Note:** Disabling this option is not compatible with the Winch
3338 /// > compiler.
3339 pub fn signals_based_traps(&mut self, enable: bool) -> &mut Self {
3340 self.tunables.signals_based_traps = Some(enable);
3341 self
3342 }
3343
3344 /// Enable/disable GC support in Wasmtime entirely.
3345 ///
3346 /// This flag can be used to gate whether GC infrastructure is enabled or
3347 /// initialized in Wasmtime at all. Wasmtime's GC implementation is required
3348 /// for the [`Self::wasm_gc`] proposal, [`Self::wasm_function_references`],
3349 /// and [`Self::wasm_exceptions`] at this time. None of those proposal can
3350 /// be enabled without also having this option enabled.
3351 ///
3352 /// This option defaults to whether the crate `gc` feature is enabled or
3353 /// not, except when using [`Strategy::Winch`] where it defaults to
3354 /// `false`.
3355 pub fn gc_support(&mut self, enable: bool) -> &mut Self {
3356 self.wasm_features(WasmFeatures::GC_TYPES, enable)
3357 }
3358
3359 /// Explicitly indicate or not whether the host is using a hardware float
3360 /// ABI on x86 targets.
3361 ///
3362 /// This configuration option is only applicable on the
3363 /// `x86_64-unknown-none` Rust target and has no effect on other host
3364 /// targets. The `x86_64-unknown-none` Rust target does not support hardware
3365 /// floats by default and uses a "soft float" implementation and ABI. This
3366 /// means that `f32`, for example, is passed in a general-purpose register
3367 /// between functions instead of a floating-point register. This does not
3368 /// match Cranelift's ABI for `f32` where it's passed in floating-point
3369 /// registers. Cranelift does not have support for a "soft float"
3370 /// implementation where all floating-point operations are lowered to
3371 /// libcalls.
3372 ///
3373 /// This means that for the `x86_64-unknown-none` target the ABI between
3374 /// Wasmtime's libcalls and the host is incompatible when floats are used.
3375 /// This further means that, by default, Wasmtime is unable to load native
3376 /// code when compiled to the `x86_64-unknown-none` target. The purpose of
3377 /// this option is to explicitly allow loading code and bypass this check.
3378 ///
3379 /// Setting this configuration option to `true` indicates that either:
3380 /// (a) the Rust target is compiled with the hard-float ABI manually via
3381 /// `-Zbuild-std` and a custom target JSON configuration, or (b) sufficient
3382 /// x86 features have been enabled in the compiler such that float libcalls
3383 /// will not be used in Wasmtime. For (a) there is no way in Rust at this
3384 /// time to detect whether a hard-float or soft-float ABI is in use on
3385 /// stable Rust, so this manual opt-in is required. For (b) the only
3386 /// instance where Wasmtime passes a floating-point value in a register
3387 /// between the host and compiled wasm code is with libcalls.
3388 ///
3389 /// Float-based libcalls are only used when the compilation target for a
3390 /// wasm module has insufficient target features enabled for native
3391 /// support. For example SSE4.1 is required for the `f32.ceil` WebAssembly
3392 /// instruction to be compiled to a native instruction. If SSE4.1 is not
3393 /// enabled then `f32.ceil` is translated to a "libcall" which is
3394 /// implemented on the host. Float-based libcalls can be avoided with
3395 /// sufficient target features enabled, for example:
3396 ///
3397 /// * `self.cranelift_flag_enable("has_sse3")`
3398 /// * `self.cranelift_flag_enable("has_ssse3")`
3399 /// * `self.cranelift_flag_enable("has_sse41")`
3400 /// * `self.cranelift_flag_enable("has_sse42")`
3401 /// * `self.cranelift_flag_enable("has_fma")`
3402 ///
3403 /// Note that when these features are enabled Wasmtime will perform a
3404 /// runtime check to determine that the host actually has the feature
3405 /// present.
3406 ///
3407 /// For some more discussion see [#11506].
3408 ///
3409 /// [#11506]: https://github.com/bytecodealliance/wasmtime/issues/11506
3410 ///
3411 /// # Safety
3412 ///
3413 /// This method is not safe because it cannot be detected in Rust right now
3414 /// whether the host is compiled with a soft or hard float ABI. Additionally
3415 /// if the host is compiled with a soft float ABI disabling this check does
3416 /// not ensure that the wasm module in question has zero usage of floats
3417 /// in the boundary to the host.
3418 ///
3419 /// Safely using this method requires one of:
3420 ///
3421 /// * The host target is compiled to use hardware floats.
3422 /// * Wasm modules loaded are compiled with enough x86 Cranelift features
3423 /// enabled to avoid float-related hostcalls.
3424 pub unsafe fn x86_float_abi_ok(&mut self, enable: bool) -> &mut Self {
3425 self.x86_float_abi_ok = Some(enable);
3426 self
3427 }
3428
3429 /// Enable or disable the ability to create a
3430 /// [`SharedMemory`](crate::SharedMemory).
3431 ///
3432 /// The WebAssembly threads proposal, configured by [`Config::wasm_threads`]
3433 /// is on-by-default but there are enough deficiencies in Wasmtime's
3434 /// implementation and API integration that creation of a shared memory is
3435 /// disabled by default. This configuration knob can be used to enable this.
3436 ///
3437 /// When enabling this method be aware that wasm threads are, at this time,
3438 /// a [tier 2
3439 /// feature](https://docs.wasmtime.dev/stability-tiers.html#tier-2) in
3440 /// Wasmtime meaning that it will not receive security updates or fixes to
3441 /// historical releases. Additionally security CVEs will not be issued for
3442 /// bugs in the implementation.
3443 ///
3444 /// This option is `false` by default.
3445 pub fn shared_memory(&mut self, enable: bool) -> &mut Self {
3446 self.shared_memory = enable;
3447 self
3448 }
3449
3450 /// Specifies whether support for concurrent execution of WebAssembly is
3451 /// supported within this store.
3452 ///
3453 /// This configuration option affects whether runtime data structures are
3454 /// initialized within a `Store` on creation to support concurrent execution
3455 /// of WebAssembly guests. This is primarily applicable to the
3456 /// [`Config::wasm_component_model_async`] configuration which is the first
3457 /// time Wasmtime has supported concurrent execution of guests. This
3458 /// configuration option, for example, enables usage of
3459 /// [`Store::run_concurrent`], [`Func::call_concurrent`], [`StreamReader`],
3460 /// etc.
3461 ///
3462 /// This configuration option can be manually disabled to avoid initializing
3463 /// data structures in the [`Store`] related to concurrent execution. When
3464 /// this option is disabled then APIs related to concurrency will all fail
3465 /// with a panic. For example [`Store::run_concurrent`] will panic, creating
3466 /// a [`StreamReader`] will panic, etc.
3467 ///
3468 /// The value of this option additionally affects whether a [`Config`] is
3469 /// valid and the default set of enabled WebAssembly features. If this
3470 /// option is disabled then component-model features related to concurrency
3471 /// will all be disabled. If this option is enabled, then the options will
3472 /// retain their normal defaults. It is not valid to create a [`Config`]
3473 /// with component-model-async explicitly enabled and this option explicitly
3474 /// disabled, however.
3475 ///
3476 /// This option defaults to `true`.
3477 ///
3478 /// [`Store`]: crate::Store
3479 /// [`Store::run_concurrent`]: crate::Store::run_concurrent
3480 /// [`Func::call_concurrent`]: crate::component::Func::call_concurrent
3481 /// [`StreamReader`]: crate::component::StreamReader
3482 pub fn concurrency_support(&mut self, enable: bool) -> &mut Self {
3483 self.tunables.concurrency_support = Some(enable);
3484 self
3485 }
3486
3487 /// Validate if the current configuration has conflicting overrides that prevent
3488 /// execution determinism. Returns an error if a conflict exists.
3489 ///
3490 /// Note: Keep this in sync with [`Config::enforce_determinism`].
3491 #[inline]
3492 #[cfg(feature = "rr")]
3493 pub(crate) fn validate_rr_determinism_conflicts(&self) -> Result<()> {
3494 if let Some(v) = self.tunables.relaxed_simd_deterministic {
3495 if v == false {
3496 bail!("Relaxed deterministic SIMD cannot be disabled when determinism is enforced");
3497 }
3498 }
3499 #[cfg(any(feature = "cranelift", feature = "winch"))]
3500 if let Some((v, _)) = self
3501 .compiler_config
3502 .as_ref()
3503 .and_then(|c| c.settings.get("enable_nan_canonicalization"))
3504 {
3505 if v != "true" {
3506 bail!("NaN canonicalization cannot be disabled when determinism is enforced");
3507 }
3508 }
3509 Ok(())
3510 }
3511
3512 /// Enable execution trace recording or replaying to the configuration.
3513 ///
3514 /// When either recording/replaying are enabled, validation fails if settings
3515 /// that control determinism are not set appropriately. In particular, RR requires
3516 /// doing the following:
3517 /// * Enabling NaN canonicalization with [`Config::cranelift_nan_canonicalization`].
3518 /// * Enabling deterministic relaxed SIMD with [`Config::relaxed_simd_deterministic`].
3519 #[inline]
3520 pub fn rr(&mut self, cfg: RRConfig) -> &mut Self {
3521 self.rr_config = cfg;
3522 self
3523 }
3524
3525 /// Whether or not trap metadata is generated in compiled wasms for internal
3526 /// asserts in the compiled code itself.
3527 ///
3528 /// Wasmtime inserts metadata within compiled artifacts which contain a
3529 /// table of known trap codes for all instructions. If a trap via a signal
3530 /// happens, and it's not listed in these tables, then that's considered a
3531 /// fatal bug that crashes the process. This option controls whether trap
3532 /// codes are inserted into metadata for internal asserts as part of
3533 /// Wasmtime's translation process. These internal asserts should never be
3534 /// triggered, but if they are then the process dies with a signal.
3535 ///
3536 /// Inserting trap metadata into compiled artifacts can take extra space in
3537 /// the final artifact. The trap tables for the artifact will be larger as
3538 /// they contain more trap codes to contain.
3539 ///
3540 /// This is intended as a debugging option and is set to `false` by
3541 /// default.
3542 pub fn metadata_for_internal_asserts(&mut self, enable: bool) -> &mut Self {
3543 self.tunables.metadata_for_internal_asserts = Some(enable);
3544 self
3545 }
3546
3547 /// Whether or not trap metadata is generated in compiled wasms for
3548 /// detection of corruption in the GC heap.
3549 ///
3550 /// For more information about what metadata is in this scenario, see
3551 /// [`Config::metadata_for_internal_asserts`]. Note, though, that this
3552 /// option is enabled by default unlike internal asserts. This is intended
3553 /// as a defense-in-depth option for generated code in the face of GC heap
3554 /// corruption. If the GC heap is corrupted and is detected then the
3555 /// trapping instruction will be gracefully handled and delivered to the
3556 /// embedder. Otherwise if this option were set to `false` then the process
3557 /// would be aborted due to a signal.
3558 pub fn metadata_for_gc_heap_corruption(&mut self, enable: bool) -> &mut Self {
3559 self.tunables.metadata_for_gc_heap_corruption = Some(enable);
3560 self
3561 }
3562}
3563
3564impl Default for Config {
3565 fn default() -> Config {
3566 Config::new()
3567 }
3568}
3569
3570impl fmt::Debug for Config {
3571 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3572 let mut f = f.debug_struct("Config");
3573
3574 // Not every flag in WasmFeatures can be enabled as part of creating
3575 // a Config. This impl gives a complete picture of all WasmFeatures
3576 // enabled, and doesn't require maintenance by hand (which has become out
3577 // of date in the past), at the cost of possible confusion for why
3578 // a flag in this set doesn't have a Config setter.
3579 let features = self.features();
3580 for flag in WasmFeatures::FLAGS.iter() {
3581 f.field(
3582 &format!("wasm_{}", flag.name().to_lowercase()),
3583 &features.contains(*flag.value()),
3584 );
3585 }
3586
3587 f.field("parallel_compilation", &self.parallel_compilation);
3588 #[cfg(any(feature = "cranelift", feature = "winch"))]
3589 {
3590 f.field("compiler_config", &self.compiler_config);
3591 }
3592
3593 self.tunables.format(&mut f);
3594 f.finish()
3595 }
3596}
3597
3598/// Possible Compilation strategies for a wasm module.
3599///
3600/// This is used as an argument to the [`Config::strategy`] method.
3601#[non_exhaustive]
3602#[derive(PartialEq, Eq, Clone, Debug, Copy)]
3603pub enum Strategy {
3604 /// An indicator that the compilation strategy should be automatically
3605 /// selected.
3606 ///
3607 /// This is generally what you want for most projects and indicates that the
3608 /// `wasmtime` crate itself should make the decision about what the best
3609 /// code generator for a wasm module is.
3610 ///
3611 /// Currently this always defaults to Cranelift, but the default value may
3612 /// change over time.
3613 Auto,
3614
3615 /// Currently the default backend, Cranelift aims to be a reasonably fast
3616 /// code generator which generates high quality machine code.
3617 Cranelift,
3618
3619 /// A low-latency baseline compiler for WebAssembly.
3620 /// For more details regarding ISA support and Wasm proposals support
3621 /// see <https://docs.wasmtime.dev/stability-tiers.html#current-tier-status>
3622 Winch,
3623}
3624
3625#[cfg(any(feature = "winch", feature = "cranelift"))]
3626impl Strategy {
3627 fn not_auto(&self) -> Option<Strategy> {
3628 match self {
3629 Strategy::Auto => {
3630 if cfg!(feature = "cranelift") {
3631 Some(Strategy::Cranelift)
3632 } else if cfg!(feature = "winch") {
3633 Some(Strategy::Winch)
3634 } else {
3635 None
3636 }
3637 }
3638 other => Some(*other),
3639 }
3640 }
3641}
3642
3643/// Possible garbage collector implementations for Wasm.
3644///
3645/// This is used as an argument to the [`Config::collector`] method.
3646///
3647/// The properties of Wasmtime's available collectors are summarized in the
3648/// following table:
3649///
3650/// | Collector | Collects Garbage[^1] | Latency[^2] | Throughput[^3] | Allocation Speed[^4] | Heap Utilization[^5] |
3651/// |-----------------------------|-----------------------|-------------|----------------|----------------------|----------------------|
3652/// | `Copying` | Yes, including cycles | 🙁 | 🙂 | 🙂 | 🙁 |
3653/// | `DeferredReferenceCounting` | Yes, but not cycles | 🙂 | 🙁 | 😐 | 😐 |
3654/// | `Null` | No | 🙂 | 🙂 | 🙂 | 🙂 |
3655///
3656/// [^1]: Whether or not the collector is capable of collecting garbage and cyclic garbage.
3657///
3658/// [^2]: How long the Wasm program is paused during garbage
3659/// collections. Shorter is better. In general, better latency implies
3660/// worse throughput and vice versa.
3661///
3662/// [^3]: How fast the Wasm program runs when using this collector. Roughly
3663/// equivalent to the number of Wasm instructions executed per
3664/// second. Faster is better. In general, better throughput implies worse
3665/// latency and vice versa.
3666///
3667/// [^4]: How fast can individual objects be allocated?
3668///
3669/// [^5]: How many objects can the collector fit into N bytes of memory? That
3670/// is, how much space for bookkeeping and metadata does this collector
3671/// require? Less space taken up by metadata means more space for
3672/// additional objects. Reference counts are larger than mark bits and
3673/// free lists are larger than bump pointers, for example.
3674#[non_exhaustive]
3675#[derive(PartialEq, Eq, Clone, Debug, Copy)]
3676pub enum Collector {
3677 /// An indicator that the garbage collector should be automatically
3678 /// selected.
3679 ///
3680 /// This is generally what you want for most projects and indicates that the
3681 /// `wasmtime` crate itself should make the decision about what the best
3682 /// collector to use is.
3683 ///
3684 /// Currently this always defaults to the copying collector, but the default
3685 /// value may change over time.
3686 Auto,
3687
3688 /// The deferred reference-counting collector.
3689 ///
3690 /// A reference-counting collector, generally trading improved latency for
3691 /// worsened throughput. However, to avoid the largest overheads of
3692 /// reference counting, it avoids manipulating reference counts for Wasm
3693 /// objects on the stack. Instead, it will hold a reference count for an
3694 /// over-approximation of all objects that are currently on the stack, trace
3695 /// the stack during collection to find the precise set of on-stack roots,
3696 /// and decrement the reference count of any object that was in the
3697 /// over-approximation but not the precise set. This improves throughput,
3698 /// compared to "pure" reference counting, by performing many fewer
3699 /// refcount-increment and -decrement operations. The cost is the increased
3700 /// latency associated with tracing the stack.
3701 ///
3702 /// This collector cannot currently collect cycles; they will leak until the
3703 /// GC heap's store is dropped.
3704 DeferredReferenceCounting,
3705
3706 /// The null collector.
3707 ///
3708 /// This collector does not actually collect any garbage. It simply
3709 /// allocates objects until it runs out of memory, at which point further
3710 /// objects allocation attempts will trap.
3711 ///
3712 /// This collector is useful for incredibly short-running Wasm instances
3713 /// where additionally you would rather halt an over-allocating Wasm program
3714 /// than spend time collecting its garbage to allow it to keep running. It
3715 /// is also useful for measuring the overheads associated with other
3716 /// collectors, as this collector imposes as close to zero throughput and
3717 /// latency overhead as possible.
3718 Null,
3719
3720 /// The copying collector.
3721 ///
3722 /// A tracing collector that splits the GC heap in half, bump-allocates
3723 /// objects in one half until it fills up, and then does a GC and copies
3724 /// live objects into the other half, and repeats the process. It has fast
3725 /// allocation, collects cyclic garbage, and good collection throughput,
3726 /// however it suffers from poor latency due to its stop-the-world
3727 /// collections and poor heap utilization due to only using half the GC
3728 /// heap's full capacity at any given time.
3729 ///
3730 /// Note that this collector is still under construction and is not yet
3731 /// functional.
3732 Copying,
3733}
3734
3735impl Default for Collector {
3736 fn default() -> Collector {
3737 Collector::Auto
3738 }
3739}
3740
3741#[cfg(feature = "gc")]
3742impl Collector {
3743 fn not_auto(&self) -> Option<Collector> {
3744 match self {
3745 Collector::Auto => {
3746 if cfg!(feature = "gc-copying") {
3747 Some(Collector::Copying)
3748 } else if cfg!(feature = "gc-drc") {
3749 Some(Collector::DeferredReferenceCounting)
3750 } else if cfg!(feature = "gc-null") {
3751 Some(Collector::Null)
3752 } else {
3753 None
3754 }
3755 }
3756 other => Some(*other),
3757 }
3758 }
3759
3760 fn try_not_auto(&self) -> Result<Self> {
3761 match self.not_auto() {
3762 #[cfg(feature = "gc-drc")]
3763 Some(c @ Collector::DeferredReferenceCounting) => Ok(c),
3764 #[cfg(not(feature = "gc-drc"))]
3765 Some(Collector::DeferredReferenceCounting) => bail!(
3766 "cannot create an engine using the deferred reference-counting \
3767 collector because the `gc-drc` feature was not enabled at \
3768 compile time",
3769 ),
3770
3771 #[cfg(feature = "gc-null")]
3772 Some(c @ Collector::Null) => Ok(c),
3773 #[cfg(not(feature = "gc-null"))]
3774 Some(Collector::Null) => bail!(
3775 "cannot create an engine using the null collector because \
3776 the `gc-null` feature was not enabled at compile time",
3777 ),
3778
3779 #[cfg(feature = "gc-copying")]
3780 Some(c @ Collector::Copying) => Ok(c),
3781 #[cfg(not(feature = "gc-copying"))]
3782 Some(Collector::Copying) => bail!(
3783 "cannot create an engine using the copying collector because \
3784 the `gc-copying` feature was not enabled at compile time",
3785 ),
3786
3787 Some(Collector::Auto) => unreachable!(),
3788
3789 None => bail!(
3790 "cannot create an engine with GC support when none of the \
3791 collectors are available; enable one of the following \
3792 features: `gc-drc`, `gc-null`, `gc-copying`",
3793 ),
3794 }
3795 }
3796}
3797
3798/// Possible optimization levels for the Cranelift codegen backend.
3799#[non_exhaustive]
3800#[derive(Copy, Clone, Debug, Eq, PartialEq)]
3801pub enum OptLevel {
3802 /// No optimizations performed, minimizes compilation time by disabling most
3803 /// optimizations.
3804 None,
3805 /// Generates the fastest possible code, but may take longer.
3806 Speed,
3807 /// Similar to `speed`, but also performs transformations aimed at reducing
3808 /// code size.
3809 SpeedAndSize,
3810}
3811
3812/// Possible register allocator algorithms for the Cranelift codegen backend.
3813#[non_exhaustive]
3814#[derive(Copy, Clone, Debug, Eq, PartialEq)]
3815pub enum RegallocAlgorithm {
3816 /// Generates the fastest possible code, but may take longer.
3817 ///
3818 /// This algorithm performs "backtracking", which means that it may
3819 /// undo its earlier work and retry as it discovers conflicts. This
3820 /// results in better register utilization, producing fewer spills
3821 /// and moves, but can cause super-linear compile runtime.
3822 Backtracking,
3823 /// Generates acceptable code very quickly.
3824 ///
3825 /// This algorithm performs a single pass through the code,
3826 /// guaranteed to work in linear time. (Note that the rest of
3827 /// Cranelift is not necessarily guaranteed to run in linear time,
3828 /// however.) It cannot undo earlier decisions, however, and it
3829 /// cannot foresee constraints or issues that may occur further
3830 /// ahead in the code, so the code may have more spills and moves as
3831 /// a result.
3832 ///
3833 /// > **Note**: This algorithm is not yet production-ready and has
3834 /// > historically had known problems. It is not recommended to enable this
3835 /// > algorithm for security-sensitive applications and the Wasmtime project
3836 /// > does not consider this configuration option for issuing security
3837 /// > advisories at this time.
3838 SinglePass,
3839}
3840
3841/// Select which profiling technique to support.
3842#[derive(Debug, Clone, Copy, PartialEq)]
3843pub enum ProfilingStrategy {
3844 /// No profiler support.
3845 None,
3846
3847 /// Collect function name information as the "perf map" file format, used with `perf` on Linux.
3848 PerfMap,
3849
3850 /// Collect profiling info for "jitdump" file format, used with `perf` on
3851 /// Linux.
3852 JitDump,
3853
3854 /// Collect profiling info using the "ittapi", used with `VTune` on Linux.
3855 VTune,
3856
3857 /// Support for profiling Pulley, Wasmtime's interpreter. Note that enabling
3858 /// this at runtime requires enabling the `profile-pulley` Cargo feature at
3859 /// compile time.
3860 Pulley,
3861}
3862
3863/// Select how wasm backtrace detailed information is handled.
3864#[derive(Debug, Clone, Copy)]
3865pub enum WasmBacktraceDetails {
3866 /// Support is unconditionally enabled and wasmtime will parse and read
3867 /// debug information.
3868 Enable,
3869
3870 /// Support is disabled, and wasmtime will not parse debug information for
3871 /// backtrace details.
3872 Disable,
3873
3874 /// Support for backtrace details is conditional on the
3875 /// `WASMTIME_BACKTRACE_DETAILS` environment variable.
3876 Environment,
3877}
3878
3879/// Describe the tri-state configuration of keys such as MPK or PAGEMAP_SCAN.
3880#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
3881pub enum Enabled {
3882 /// Enable this feature if it's detected on the host system, otherwise leave
3883 /// it disabled.
3884 Auto,
3885 /// Enable this feature and fail configuration if the feature is not
3886 /// detected on the host system.
3887 Yes,
3888 /// Do not enable this feature, even if the host system supports it.
3889 No,
3890}
3891
3892/// Configuration options used with [`InstanceAllocationStrategy::Pooling`] to
3893/// change the behavior of the pooling instance allocator.
3894///
3895/// This structure has a builder-style API in the same manner as [`Config`] and
3896/// is configured with [`Config::allocation_strategy`].
3897///
3898/// Note that usage of the pooling allocator does not affect compiled
3899/// WebAssembly code. Compiled `*.cwasm` files, for example, are usable both
3900/// with and without the pooling allocator.
3901///
3902/// ## Advantages of Pooled Allocation
3903///
3904/// The main benefit of the pooling allocator is to make WebAssembly
3905/// instantiation both faster and more scalable in terms of parallelism.
3906/// Allocation is faster because virtual memory is already configured and ready
3907/// to go within the pool, there's no need to [`mmap`] (for example on Unix) a
3908/// new region and configure it with guard pages. By avoiding [`mmap`] this
3909/// avoids whole-process virtual memory locks which can improve scalability and
3910/// performance through avoiding this.
3911///
3912/// Additionally with pooled allocation it's possible to create "affine slots"
3913/// to a particular WebAssembly module or component over time. For example if
3914/// the same module is multiple times over time the pooling allocator will, by
3915/// default, attempt to reuse the same slot. This mean that the slot has been
3916/// pre-configured and can retain virtual memory mappings for a copy-on-write
3917/// image, for example (see [`Config::memory_init_cow`] for more information.
3918/// This means that in a steady state instance deallocation is a single
3919/// [`madvise`] to reset linear memory to its original contents followed by a
3920/// single (optional) [`mprotect`] during the next instantiation to shrink
3921/// memory back to its original size. Compared to non-pooled allocation this
3922/// avoids the need to [`mmap`] a new region of memory, [`munmap`] it, and
3923/// [`mprotect`] regions too.
3924///
3925/// Another benefit of pooled allocation is that it's possible to configure
3926/// things such that no virtual memory management is required at all in a steady
3927/// state. For example a pooling allocator can be configured with:
3928///
3929/// * [`Config::memory_init_cow`] disabled
3930/// * [`Config::memory_guard_size`] disabled
3931/// * [`Config::memory_reservation`] shrunk to minimal size
3932/// * [`PoolingAllocationConfig::table_keep_resident`] sufficiently large
3933/// * [`PoolingAllocationConfig::linear_memory_keep_resident`] sufficiently large
3934///
3935/// With all these options in place no virtual memory tricks are used at all and
3936/// everything is manually managed by Wasmtime (for example resetting memory is
3937/// a `memset(0)`). This is not as fast in a single-threaded scenario but can
3938/// provide benefits in high-parallelism situations as no virtual memory locks
3939/// or IPIs need happen.
3940///
3941/// ## Disadvantages of Pooled Allocation
3942///
3943/// Despite the above advantages to instantiation performance the pooling
3944/// allocator is not enabled by default in Wasmtime. One reason is that the
3945/// performance advantages are not necessarily portable, for example while the
3946/// pooling allocator works on Windows it has not been tuned for performance on
3947/// Windows in the same way it has on Linux.
3948///
3949/// Additionally the main cost of the pooling allocator is that it requires a
3950/// very large reservation of virtual memory (on the order of most of the
3951/// addressable virtual address space). WebAssembly 32-bit linear memories in
3952/// Wasmtime are, by default 4G address space reservations with a small guard
3953/// region both before and after the linear memory. Memories in the pooling
3954/// allocator are contiguous which means that we only need a guard after linear
3955/// memory because the previous linear memory's slot post-guard is our own
3956/// pre-guard. This means that, by default, the pooling allocator uses roughly
3957/// 4G of virtual memory per WebAssembly linear memory slot. 4G of virtual
3958/// memory is 32 bits of a 64-bit address. Many 64-bit systems can only
3959/// actually use 48-bit addresses by default (although this can be extended on
3960/// architectures nowadays too), and of those 48 bits one of them is reserved
3961/// to indicate kernel-vs-userspace. This leaves 47-32=15 bits left,
3962/// meaning you can only have at most 32k slots of linear memories on many
3963/// systems by default. This is a relatively small number and shows how the
3964/// pooling allocator can quickly exhaust all of virtual memory.
3965///
3966/// Another disadvantage of the pooling allocator is that it may keep memory
3967/// alive when nothing is using it. A previously used slot for an instance might
3968/// have paged-in memory that will not get paged out until the
3969/// [`Engine`] owning the pooling allocator is dropped. While
3970/// suitable for some applications this behavior may not be suitable for all
3971/// applications.
3972///
3973/// Finally the last disadvantage of the pooling allocator is that the
3974/// configuration values for the maximum number of instances, memories, tables,
3975/// etc, must all be fixed up-front. There's not always a clear answer as to
3976/// what these values should be so not all applications may be able to work
3977/// with this constraint.
3978///
3979/// [`madvise`]: https://man7.org/linux/man-pages/man2/madvise.2.html
3980/// [`mprotect`]: https://man7.org/linux/man-pages/man2/mprotect.2.html
3981/// [`mmap`]: https://man7.org/linux/man-pages/man2/mmap.2.html
3982/// [`munmap`]: https://man7.org/linux/man-pages/man2/munmap.2.html
3983#[derive(Debug, Clone)]
3984pub struct PoolingAllocationConfig {
3985 /// See `PoolingAllocatorConfig::max_unused_warm_slots` in `wasmtime`
3986 pub(crate) max_unused_warm_slots: u32,
3987 /// The target number of decommits to do per batch. This is not precise, as
3988 /// we can queue up decommits at times when we aren't prepared to
3989 /// immediately flush them, and so we may go over this target size
3990 /// occasionally.
3991 pub(crate) decommit_batch_size: usize,
3992 /// The size, in bytes, of async stacks to allocate (not including the guard
3993 /// page).
3994 #[cfg_attr(
3995 not(all(feature = "async", feature = "pooling-allocator")),
3996 expect(dead_code, reason = "easier to cfg")
3997 )]
3998 pub(crate) stack_size: usize,
3999 /// The limits to apply to instances allocated within this allocator.
4000 pub(crate) limits: InstanceLimits,
4001 /// Whether or not async stacks are zeroed after use.
4002 #[cfg_attr(
4003 not(all(feature = "async", feature = "pooling-allocator")),
4004 expect(dead_code, reason = "easier to cfg")
4005 )]
4006 pub(crate) async_stack_zeroing: bool,
4007 /// If async stack zeroing is enabled and the host platform is Linux this is
4008 /// how much memory to zero out with `memset`.
4009 ///
4010 /// The rest of memory will be zeroed out with `madvise`.
4011 pub(crate) async_stack_keep_resident: usize,
4012 /// How much linear memory, in bytes, to keep resident after resetting for
4013 /// use with the next instance. This much memory will be `memset` to zero
4014 /// when a linear memory is deallocated.
4015 ///
4016 /// Memory exceeding this amount in the wasm linear memory will be released
4017 /// with `madvise` back to the kernel.
4018 ///
4019 /// Only applicable on Linux.
4020 pub(crate) linear_memory_keep_resident: usize,
4021 /// Same as `linear_memory_keep_resident` but for tables.
4022 pub(crate) table_keep_resident: usize,
4023 /// Whether to enable memory protection keys.
4024 pub(crate) memory_protection_keys: Enabled,
4025 /// How many memory protection keys to allocate.
4026 pub(crate) max_memory_protection_keys: usize,
4027 /// Whether to enable PAGEMAP_SCAN on Linux.
4028 pub(crate) pagemap_scan: Enabled,
4029}
4030
4031impl Default for PoolingAllocationConfig {
4032 fn default() -> Self {
4033 Self {
4034 max_unused_warm_slots: 100,
4035 decommit_batch_size: 1,
4036 stack_size: 2 << 20,
4037 limits: InstanceLimits::default(),
4038 async_stack_zeroing: false,
4039 async_stack_keep_resident: 0,
4040 linear_memory_keep_resident: 0,
4041 table_keep_resident: 0,
4042 memory_protection_keys: Enabled::No,
4043 max_memory_protection_keys: 16,
4044 pagemap_scan: Enabled::No,
4045 }
4046 }
4047}
4048
4049/// Instance-related limit configuration for pooling.
4050///
4051/// More docs on this can be found at `wasmtime::PoolingAllocationConfig`.
4052#[derive(Debug, Copy, Clone)]
4053pub(crate) struct InstanceLimits {
4054 /// The maximum number of component instances that may be allocated
4055 /// concurrently.
4056 pub(crate) total_component_instances: u32,
4057
4058 /// The maximum size of a component's `VMComponentContext`, including
4059 /// the aggregate size of all its inner core modules' `VMContext` sizes.
4060 pub(crate) component_instance_size: usize,
4061
4062 /// The maximum number of core module instances that may be allocated
4063 /// concurrently.
4064 pub(crate) total_core_instances: u32,
4065
4066 /// The maximum number of core module instances that a single component may
4067 /// transitively contain.
4068 pub(crate) max_core_instances_per_component: u32,
4069
4070 /// The maximum number of Wasm linear memories that a component may
4071 /// transitively contain.
4072 pub(crate) max_memories_per_component: u32,
4073
4074 /// The maximum number of tables that a component may transitively contain.
4075 pub(crate) max_tables_per_component: u32,
4076
4077 /// The total number of linear memories in the pool, across all instances.
4078 pub(crate) total_memories: u32,
4079
4080 /// The total number of tables in the pool, across all instances.
4081 pub(crate) total_tables: u32,
4082
4083 /// The total number of async stacks in the pool, across all instances.
4084 pub(crate) total_stacks: u32,
4085
4086 /// Maximum size of a core instance's `VMContext`.
4087 pub(crate) core_instance_size: usize,
4088
4089 /// Maximum number of tables per instance.
4090 pub(crate) max_tables_per_module: u32,
4091
4092 /// Maximum number of word-size elements per table.
4093 ///
4094 /// Note that tables for element types such as continuations
4095 /// that use more than one word of storage may store fewer
4096 /// elements.
4097 pub(crate) table_elements: usize,
4098
4099 /// Maximum number of linear memories per instance.
4100 pub(crate) max_memories_per_module: u32,
4101
4102 /// Maximum byte size of a linear memory, must be smaller than
4103 /// `memory_reservation` in `Tunables`.
4104 pub(crate) max_memory_size: usize,
4105
4106 /// The total number of GC heaps in the pool, across all instances.
4107 pub(crate) total_gc_heaps: u32,
4108}
4109
4110impl Default for InstanceLimits {
4111 fn default() -> Self {
4112 let total = if cfg!(target_pointer_width = "32") {
4113 100
4114 } else {
4115 1000
4116 };
4117 // See doc comments for `wasmtime::PoolingAllocationConfig` for these
4118 // default values
4119 Self {
4120 total_component_instances: total,
4121 component_instance_size: 1 << 20, // 1 MiB
4122 total_core_instances: total,
4123 max_core_instances_per_component: u32::MAX,
4124 max_memories_per_component: u32::MAX,
4125 max_tables_per_component: u32::MAX,
4126 total_memories: total,
4127 total_tables: total,
4128 total_stacks: total,
4129 core_instance_size: 1 << 20, // 1 MiB
4130 max_tables_per_module: 1,
4131 // NB: in #8504 it was seen that a C# module in debug module can
4132 // have 10k+ elements.
4133 table_elements: 20_000,
4134 max_memories_per_module: 1,
4135 #[cfg(target_pointer_width = "64")]
4136 max_memory_size: 1 << 32, // 4G,
4137 #[cfg(target_pointer_width = "32")]
4138 max_memory_size: 10 << 20, // 10 MiB
4139 total_gc_heaps: total,
4140 }
4141 }
4142}
4143
4144impl PoolingAllocationConfig {
4145 /// Returns a new configuration builder with all default settings
4146 /// configured.
4147 pub fn new() -> PoolingAllocationConfig {
4148 PoolingAllocationConfig::default()
4149 }
4150
4151 /// Configures the maximum number of "unused warm slots" to retain in the
4152 /// pooling allocator.
4153 ///
4154 /// The pooling allocator operates over slots to allocate from, and each
4155 /// slot is considered "cold" if it's never been used before or "warm" if
4156 /// it's been used by some module in the past. Slots in the pooling
4157 /// allocator additionally track an "affinity" flag to a particular core
4158 /// wasm module. When a module is instantiated into a slot then the slot is
4159 /// considered affine to that module, even after the instance has been
4160 /// deallocated.
4161 ///
4162 /// When a new instance is created then a slot must be chosen, and the
4163 /// current algorithm for selecting a slot is:
4164 ///
4165 /// * If there are slots that are affine to the module being instantiated,
4166 /// then the most recently used slot is selected to be allocated from.
4167 /// This is done to improve reuse of resources such as memory mappings and
4168 /// additionally try to benefit from temporal locality for things like
4169 /// caches.
4170 ///
4171 /// * Otherwise if there are more than N affine slots to other modules, then
4172 /// one of those affine slots is chosen to be allocated. The slot chosen
4173 /// is picked on a least-recently-used basis.
4174 ///
4175 /// * Finally, if there are less than N affine slots to other modules, then
4176 /// the non-affine slots are allocated from.
4177 ///
4178 /// This setting, `max_unused_warm_slots`, is the value for N in the above
4179 /// algorithm. The purpose of this setting is to have a knob over the RSS
4180 /// impact of "unused slots" for a long-running wasm server.
4181 ///
4182 /// If this setting is set to 0, for example, then affine slots are
4183 /// aggressively reused on a least-recently-used basis. A "cold" slot is
4184 /// only used if there are no affine slots available to allocate from. This
4185 /// means that the set of slots used over the lifetime of a program is the
4186 /// same as the maximum concurrent number of wasm instances.
4187 ///
4188 /// If this setting is set to infinity, however, then cold slots are
4189 /// prioritized to be allocated from. This means that the set of slots used
4190 /// over the lifetime of a program will approach
4191 /// [`PoolingAllocationConfig::total_memories`], or the maximum number of
4192 /// slots in the pooling allocator.
4193 ///
4194 /// Wasmtime does not aggressively decommit all resources associated with a
4195 /// slot when the slot is not in use. For example the
4196 /// [`PoolingAllocationConfig::linear_memory_keep_resident`] option can be
4197 /// used to keep memory associated with a slot, even when it's not in use.
4198 /// This means that the total set of used slots in the pooling instance
4199 /// allocator can impact the overall RSS usage of a program.
4200 ///
4201 /// The default value for this option is `100`.
4202 pub fn max_unused_warm_slots(&mut self, max: u32) -> &mut Self {
4203 self.max_unused_warm_slots = max;
4204 self
4205 }
4206
4207 /// The target number of decommits to do per batch.
4208 ///
4209 /// This is not precise, as we can queue up decommits at times when we
4210 /// aren't prepared to immediately flush them, and so we may go over this
4211 /// target size occasionally.
4212 ///
4213 /// Note additionally that the queue of not-yet-decommitted entities is
4214 /// sharded to reduce lock contention: one shard per available CPU, capped
4215 /// at 16. Each shard batches up to this many decommits independently,
4216 /// meaning that up to `min(available_parallelism, 16) * (batch_size - 1)`
4217 /// decommits may be queued and not yet flushed at any given time.
4218 ///
4219 /// A batch size of one effectively disables batching.
4220 ///
4221 /// Defaults to `1`.
4222 pub fn decommit_batch_size(&mut self, batch_size: usize) -> &mut Self {
4223 self.decommit_batch_size = batch_size;
4224 self
4225 }
4226
4227 /// How much memory, in bytes, to keep resident for async stacks allocated
4228 /// with the pooling allocator.
4229 ///
4230 /// When [`Config::async_stack_zeroing`] is enabled then Wasmtime will reset
4231 /// the contents of async stacks back to zero upon deallocation. This option
4232 /// can be used to perform the zeroing operation with `memset` up to a
4233 /// certain threshold of bytes instead of using system calls to reset the
4234 /// stack to zero.
4235 ///
4236 /// Note that when using this option the memory with async stacks will
4237 /// never be decommitted.
4238 pub fn async_stack_keep_resident(&mut self, size: usize) -> &mut Self {
4239 self.async_stack_keep_resident = size;
4240 self
4241 }
4242
4243 /// How much memory, in bytes, to keep resident for each linear memory
4244 /// after deallocation.
4245 ///
4246 /// This option is only applicable on Linux and has no effect on other
4247 /// platforms.
4248 ///
4249 /// By default Wasmtime will use `madvise` to reset the entire contents of
4250 /// linear memory back to zero when a linear memory is deallocated. This
4251 /// option can be used to use `memset` instead to set memory back to zero
4252 /// which can, in some configurations, reduce the number of page faults
4253 /// taken when a slot is reused.
4254 pub fn linear_memory_keep_resident(&mut self, size: usize) -> &mut Self {
4255 self.linear_memory_keep_resident = size;
4256 self
4257 }
4258
4259 /// How much memory, in bytes, to keep resident for each table after
4260 /// deallocation.
4261 ///
4262 /// This option is only applicable on Linux and has no effect on other
4263 /// platforms.
4264 ///
4265 /// This option is the same as
4266 /// [`PoolingAllocationConfig::linear_memory_keep_resident`] except that it
4267 /// is applicable to tables instead.
4268 pub fn table_keep_resident(&mut self, size: usize) -> &mut Self {
4269 self.table_keep_resident = size;
4270 self
4271 }
4272
4273 /// The maximum number of concurrent component instances supported (default
4274 /// is `1000`).
4275 ///
4276 /// This provides an upper-bound on the total size of component
4277 /// metadata-related allocations, along with
4278 /// [`PoolingAllocationConfig::max_component_instance_size`]. The upper bound is
4279 ///
4280 /// ```text
4281 /// total_component_instances * max_component_instance_size
4282 /// ```
4283 ///
4284 /// where `max_component_instance_size` is rounded up to the size and alignment
4285 /// of the internal representation of the metadata.
4286 pub fn total_component_instances(&mut self, count: u32) -> &mut Self {
4287 self.limits.total_component_instances = count;
4288 self
4289 }
4290
4291 /// The maximum size, in bytes, allocated for a component instance's
4292 /// `VMComponentContext` metadata as well as the aggregate size of this
4293 /// component's core instances `VMContext` metadata.
4294 ///
4295 /// The [`wasmtime::component::Instance`][crate::component::Instance] type
4296 /// has a static size but its internal `VMComponentContext` is dynamically
4297 /// sized depending on the component being instantiated. This size limit
4298 /// loosely correlates to the size of the component, taking into account
4299 /// factors such as:
4300 ///
4301 /// * number of lifted and lowered functions,
4302 /// * number of memories
4303 /// * number of inner instances
4304 /// * number of resources
4305 ///
4306 /// If the allocated size per instance is too small then instantiation of a
4307 /// module will fail at runtime with an error indicating how many bytes were
4308 /// needed.
4309 ///
4310 /// In addition to the memory in the runtime for the component itself,
4311 /// components contain one or more core module instances. Each of these
4312 /// require some memory in the runtime as described in
4313 /// [`PoolingAllocationConfig::max_core_instance_size`]. The limit here
4314 /// applies against the sum of all of these individual allocations.
4315 ///
4316 /// The default value for this is 1MiB.
4317 ///
4318 /// This provides an upper-bound on the total size of all component's
4319 /// metadata-related allocations (for both the component and its embedded
4320 /// core module instances), along with
4321 /// [`PoolingAllocationConfig::total_component_instances`]. The upper bound is
4322 ///
4323 /// ```text
4324 /// total_component_instances * max_component_instance_size
4325 /// ```
4326 ///
4327 /// where `max_component_instance_size` is rounded up to the size and alignment
4328 /// of the internal representation of the metadata.
4329 pub fn max_component_instance_size(&mut self, size: usize) -> &mut Self {
4330 self.limits.component_instance_size = size;
4331 self
4332 }
4333
4334 /// The maximum number of core instances a single component may contain
4335 /// (default is unlimited).
4336 ///
4337 /// This method (along with
4338 /// [`PoolingAllocationConfig::max_memories_per_component`],
4339 /// [`PoolingAllocationConfig::max_tables_per_component`], and
4340 /// [`PoolingAllocationConfig::max_component_instance_size`]) allows you to cap
4341 /// the amount of resources a single component allocation consumes.
4342 ///
4343 /// If a component will instantiate more core instances than `count`, then
4344 /// the component will fail to instantiate.
4345 pub fn max_core_instances_per_component(&mut self, count: u32) -> &mut Self {
4346 self.limits.max_core_instances_per_component = count;
4347 self
4348 }
4349
4350 /// The maximum number of Wasm linear memories that a single component may
4351 /// transitively contain (default is unlimited).
4352 ///
4353 /// This method (along with
4354 /// [`PoolingAllocationConfig::max_core_instances_per_component`],
4355 /// [`PoolingAllocationConfig::max_tables_per_component`], and
4356 /// [`PoolingAllocationConfig::max_component_instance_size`]) allows you to cap
4357 /// the amount of resources a single component allocation consumes.
4358 ///
4359 /// If a component transitively contains more linear memories than `count`,
4360 /// then the component will fail to instantiate.
4361 pub fn max_memories_per_component(&mut self, count: u32) -> &mut Self {
4362 self.limits.max_memories_per_component = count;
4363 self
4364 }
4365
4366 /// The maximum number of tables that a single component may transitively
4367 /// contain (default is unlimited).
4368 ///
4369 /// This method (along with
4370 /// [`PoolingAllocationConfig::max_core_instances_per_component`],
4371 /// [`PoolingAllocationConfig::max_memories_per_component`],
4372 /// [`PoolingAllocationConfig::max_component_instance_size`]) allows you to cap
4373 /// the amount of resources a single component allocation consumes.
4374 ///
4375 /// If a component will transitively contains more tables than `count`, then
4376 /// the component will fail to instantiate.
4377 pub fn max_tables_per_component(&mut self, count: u32) -> &mut Self {
4378 self.limits.max_tables_per_component = count;
4379 self
4380 }
4381
4382 /// The maximum number of concurrent Wasm linear memories supported (default
4383 /// is `1000`).
4384 ///
4385 /// This value has a direct impact on the amount of memory allocated by the pooling
4386 /// instance allocator.
4387 ///
4388 /// The pooling instance allocator allocates a memory pool, where each entry
4389 /// in the pool contains the reserved address space for each linear memory
4390 /// supported by an instance.
4391 ///
4392 /// The memory pool will reserve a large quantity of host process address
4393 /// space to elide the bounds checks required for correct WebAssembly memory
4394 /// semantics. Even with 64-bit address spaces, the address space is limited
4395 /// when dealing with a large number of linear memories.
4396 ///
4397 /// For example, on Linux x86_64, the userland address space limit is 128
4398 /// TiB. That might seem like a lot, but each linear memory will *reserve* 6
4399 /// GiB of space by default.
4400 pub fn total_memories(&mut self, count: u32) -> &mut Self {
4401 self.limits.total_memories = count;
4402 self
4403 }
4404
4405 /// The maximum number of concurrent tables supported (default is `1000`).
4406 ///
4407 /// This value has a direct impact on the amount of memory allocated by the
4408 /// pooling instance allocator.
4409 ///
4410 /// The pooling instance allocator allocates a table pool, where each entry
4411 /// in the pool contains the space needed for each WebAssembly table
4412 /// supported by an instance (see `table_elements` to control the size of
4413 /// each table).
4414 pub fn total_tables(&mut self, count: u32) -> &mut Self {
4415 self.limits.total_tables = count;
4416 self
4417 }
4418
4419 /// The maximum number of execution stacks allowed for asynchronous
4420 /// execution, when enabled (default is `1000`).
4421 ///
4422 /// This value has a direct impact on the amount of memory allocated by the
4423 /// pooling instance allocator.
4424 #[cfg(feature = "async")]
4425 pub fn total_stacks(&mut self, count: u32) -> &mut Self {
4426 self.limits.total_stacks = count;
4427 self
4428 }
4429
4430 /// The maximum number of concurrent core instances supported (default is
4431 /// `1000`).
4432 ///
4433 /// This provides an upper-bound on the total size of core instance
4434 /// metadata-related allocations, along with
4435 /// [`PoolingAllocationConfig::max_core_instance_size`]. The upper bound is
4436 ///
4437 /// ```text
4438 /// total_core_instances * max_core_instance_size
4439 /// ```
4440 ///
4441 /// where `max_core_instance_size` is rounded up to the size and alignment of
4442 /// the internal representation of the metadata.
4443 pub fn total_core_instances(&mut self, count: u32) -> &mut Self {
4444 self.limits.total_core_instances = count;
4445 self
4446 }
4447
4448 /// The maximum size, in bytes, allocated for a core instance's `VMContext`
4449 /// metadata.
4450 ///
4451 /// The [`Instance`][crate::Instance] type has a static size but its
4452 /// `VMContext` metadata is dynamically sized depending on the module being
4453 /// instantiated. This size limit loosely correlates to the size of the Wasm
4454 /// module, taking into account factors such as:
4455 ///
4456 /// * number of functions
4457 /// * number of globals
4458 /// * number of memories
4459 /// * number of tables
4460 /// * number of function types
4461 ///
4462 /// If the allocated size per instance is too small then instantiation of a
4463 /// module will fail at runtime with an error indicating how many bytes were
4464 /// needed.
4465 ///
4466 /// The default value for this is 1MiB.
4467 ///
4468 /// This provides an upper-bound on the total size of core instance
4469 /// metadata-related allocations, along with
4470 /// [`PoolingAllocationConfig::total_core_instances`]. The upper bound is
4471 ///
4472 /// ```text
4473 /// total_core_instances * max_core_instance_size
4474 /// ```
4475 ///
4476 /// where `max_core_instance_size` is rounded up to the size and alignment of
4477 /// the internal representation of the metadata.
4478 pub fn max_core_instance_size(&mut self, size: usize) -> &mut Self {
4479 self.limits.core_instance_size = size;
4480 self
4481 }
4482
4483 /// The maximum number of defined tables for a core module (default is `1`).
4484 ///
4485 /// This value controls the capacity of the `VMTableDefinition` table in
4486 /// each instance's `VMContext` structure.
4487 ///
4488 /// The allocated size of the table will be `tables *
4489 /// sizeof(VMTableDefinition)` for each instance regardless of how many
4490 /// tables are defined by an instance's module.
4491 pub fn max_tables_per_module(&mut self, tables: u32) -> &mut Self {
4492 self.limits.max_tables_per_module = tables;
4493 self
4494 }
4495
4496 /// The maximum table elements for any table defined in a module (default is
4497 /// `20000`).
4498 ///
4499 /// If a table's minimum element limit is greater than this value, the
4500 /// module will fail to instantiate.
4501 ///
4502 /// If a table's maximum element limit is unbounded or greater than this
4503 /// value, the maximum will be `table_elements` for the purpose of any
4504 /// `table.grow` instruction.
4505 ///
4506 /// This value is used to reserve the maximum space for each supported
4507 /// table; table elements are pointer-sized in the Wasmtime runtime.
4508 /// Therefore, the space reserved for each instance is `tables *
4509 /// table_elements * sizeof::<*const ()>`.
4510 pub fn table_elements(&mut self, elements: usize) -> &mut Self {
4511 self.limits.table_elements = elements;
4512 self
4513 }
4514
4515 /// The maximum number of defined linear memories for a module (default is
4516 /// `1`).
4517 ///
4518 /// This value controls the capacity of the `VMMemoryDefinition` table in
4519 /// each core instance's `VMContext` structure.
4520 ///
4521 /// The allocated size of the table will be `memories *
4522 /// sizeof(VMMemoryDefinition)` for each core instance regardless of how
4523 /// many memories are defined by the core instance's module.
4524 pub fn max_memories_per_module(&mut self, memories: u32) -> &mut Self {
4525 self.limits.max_memories_per_module = memories;
4526 self
4527 }
4528
4529 /// The maximum byte size that any WebAssembly linear memory may grow to.
4530 ///
4531 /// This option defaults to 4 GiB meaning that for 32-bit linear memories
4532 /// there is no restrictions. 64-bit linear memories will not be allowed to
4533 /// grow beyond 4 GiB by default.
4534 ///
4535 /// If a memory's minimum size is greater than this value, the module will
4536 /// fail to instantiate.
4537 ///
4538 /// If a memory's maximum size is unbounded or greater than this value, the
4539 /// maximum will be `max_memory_size` for the purpose of any `memory.grow`
4540 /// instruction.
4541 ///
4542 /// This value is used to control the maximum accessible space for each
4543 /// linear memory of a core instance. This can be thought of as a simple
4544 /// mechanism like [`Store::limiter`](crate::Store::limiter) to limit memory
4545 /// at runtime. This value can also affect striping/coloring behavior when
4546 /// used in conjunction with
4547 /// [`memory_protection_keys`](PoolingAllocationConfig::memory_protection_keys).
4548 ///
4549 /// The virtual memory reservation size of each linear memory is controlled
4550 /// by the [`Config::memory_reservation`] setting and this method's
4551 /// configuration cannot exceed [`Config::memory_reservation`].
4552 pub fn max_memory_size(&mut self, bytes: usize) -> &mut Self {
4553 self.limits.max_memory_size = bytes;
4554 self
4555 }
4556
4557 /// Configures whether memory protection keys (MPK) should be used for more
4558 /// efficient layout of pool-allocated memories.
4559 ///
4560 /// When using the pooling allocator (see [`Config::allocation_strategy`],
4561 /// [`InstanceAllocationStrategy::Pooling`]), memory protection keys can
4562 /// reduce the total amount of allocated virtual memory by eliminating guard
4563 /// regions between WebAssembly memories in the pool. It does so by
4564 /// "coloring" memory regions with different memory keys and setting which
4565 /// regions are accessible each time executions switches from host to guest
4566 /// (or vice versa).
4567 ///
4568 /// Leveraging MPK requires configuring a smaller-than-default
4569 /// [`max_memory_size`](PoolingAllocationConfig::max_memory_size) to enable
4570 /// this coloring/striping behavior. For example embeddings might want to
4571 /// reduce the default 4G allowance to 128M.
4572 ///
4573 /// MPK is only available on Linux (called `pku` there) and recent x86
4574 /// systems; we check for MPK support at runtime by examining the `CPUID`
4575 /// register. This configuration setting can be in three states:
4576 ///
4577 /// - `auto`: if MPK support is available the guard regions are removed; if
4578 /// not, the guard regions remain
4579 /// - `yes`: use MPK to eliminate guard regions; fail if MPK is not
4580 /// supported
4581 /// - `no`: never use MPK
4582 ///
4583 /// By default this value is `no`, but may become `auto` in future
4584 /// releases.
4585 ///
4586 /// __WARNING__: this configuration options is still experimental--use at
4587 /// your own risk! MPK uses kernel and CPU features to protect memory
4588 /// regions; you may observe segmentation faults if anything is
4589 /// misconfigured.
4590 #[cfg(feature = "memory-protection-keys")]
4591 pub fn memory_protection_keys(&mut self, enable: Enabled) -> &mut Self {
4592 self.memory_protection_keys = enable;
4593 self
4594 }
4595
4596 /// Sets an upper limit on how many memory protection keys (MPK) Wasmtime
4597 /// will use.
4598 ///
4599 /// This setting is only applicable when
4600 /// [`PoolingAllocationConfig::memory_protection_keys`] is set to `enable`
4601 /// or `auto`. Configuring this above the HW and OS limits (typically 15)
4602 /// has no effect.
4603 ///
4604 /// If multiple Wasmtime engines are used in the same process, note that all
4605 /// engines will share the same set of allocated keys; this setting will
4606 /// limit how many keys are allocated initially and thus available to all
4607 /// other engines.
4608 #[cfg(feature = "memory-protection-keys")]
4609 pub fn max_memory_protection_keys(&mut self, max: usize) -> &mut Self {
4610 self.max_memory_protection_keys = max;
4611 self
4612 }
4613
4614 /// Check if memory protection keys (MPK) are available on the current host.
4615 ///
4616 /// This is a convenience method for determining MPK availability using the
4617 /// same method that [`Enabled::Auto`] does. See
4618 /// [`PoolingAllocationConfig::memory_protection_keys`] for more
4619 /// information.
4620 #[cfg(feature = "memory-protection-keys")]
4621 pub fn are_memory_protection_keys_available() -> bool {
4622 crate::runtime::vm::mpk::is_supported()
4623 }
4624
4625 /// The maximum number of concurrent GC heaps supported (default is `1000`).
4626 ///
4627 /// This value has a direct impact on the amount of memory allocated by the
4628 /// pooling instance allocator.
4629 ///
4630 /// The pooling instance allocator allocates a GC heap pool, where each
4631 /// entry in the pool contains the space needed for each GC heap used by a
4632 /// store.
4633 #[cfg(feature = "gc")]
4634 pub fn total_gc_heaps(&mut self, count: u32) -> &mut Self {
4635 self.limits.total_gc_heaps = count;
4636 self
4637 }
4638
4639 /// Configures whether the Linux-specific [`PAGEMAP_SCAN` ioctl][ioctl] is
4640 /// used to help reset linear memory.
4641 ///
4642 /// When [`Self::linear_memory_keep_resident`] or
4643 /// [`Self::table_keep_resident`] options are configured to nonzero values
4644 /// the default behavior is to `memset` the lowest addresses of a table or
4645 /// memory back to their original contents. With the `PAGEMAP_SCAN` ioctl on
4646 /// Linux this can be done to more intelligently scan for resident pages in
4647 /// the region and only reset those pages back to their original contents
4648 /// with `memset` rather than assuming the low addresses are all resident.
4649 ///
4650 /// This ioctl has the potential to provide a number of performance benefits
4651 /// in high-reuse and high concurrency scenarios. Notably this enables
4652 /// Wasmtime to scan the entire region of WebAssembly linear memory and
4653 /// manually reset memory back to its original contents, up to
4654 /// [`Self::linear_memory_keep_resident`] bytes, possibly skipping an
4655 /// `madvise` entirely. This can be more efficient by avoiding removing
4656 /// pages from the address space entirely and additionally ensuring that
4657 /// future use of the linear memory doesn't incur page faults as the pages
4658 /// remain resident.
4659 ///
4660 /// At this time this configuration option is still being evaluated as to
4661 /// how appropriate it is for all use cases. It currently defaults to
4662 /// `no` or disabled but may change to `auto`, enable if supported, in the
4663 /// future. This option is only supported on Linux and requires a kernel
4664 /// version of 6.7 or higher.
4665 ///
4666 /// [ioctl]: https://www.man7.org/linux/man-pages/man2/PAGEMAP_SCAN.2const.html
4667 pub fn pagemap_scan(&mut self, enable: Enabled) -> &mut Self {
4668 self.pagemap_scan = enable;
4669 self
4670 }
4671
4672 /// Returns the configured
4673 /// [`PoolingAllocationConfig::decommit_batch_size`], if enabled.
4674 pub fn get_decommit_batch_size(&self) -> usize {
4675 self.decommit_batch_size
4676 }
4677
4678 /// Returns the configured
4679 /// [`PoolingAllocationConfig::max_unused_warm_slots`], if enabled.
4680 pub fn get_max_unused_warm_slots(&self) -> u32 {
4681 self.max_unused_warm_slots
4682 }
4683
4684 /// Returns the configured
4685 /// [`PoolingAllocationConfig::linear_memory_keep_resident`], if
4686 /// enabled.
4687 pub fn get_memory_keep_resident(&self) -> usize {
4688 self.linear_memory_keep_resident
4689 }
4690
4691 /// Returns the configured
4692 /// [`PoolingAllocationConfig::table_keep_resident`], if enabled.
4693 pub fn get_table_keep_resident(&self) -> usize {
4694 self.table_keep_resident
4695 }
4696
4697 /// Returns the configured
4698 /// [`PoolingAllocationConfig::async_stack_keep_resident`], if
4699 /// enabled.
4700 pub fn get_async_stack_keep_resident(&self) -> usize {
4701 self.async_stack_keep_resident
4702 }
4703
4704 /// Returns the configured
4705 /// [`PoolingAllocationConfig::memory_protection_keys`], if enabled.
4706 pub fn get_memory_protection_keys(&self) -> Enabled {
4707 self.memory_protection_keys
4708 }
4709
4710 /// Returns the configured
4711 /// [`PoolingAllocationConfig::max_memory_protection_keys`], if
4712 /// enabled.
4713 pub fn get_max_memory_protection_keys(&self) -> usize {
4714 self.max_memory_protection_keys
4715 }
4716
4717 /// Returns the configured
4718 /// [`PoolingAllocationConfig::pagemap_scan`], if enabled.
4719 pub fn get_pagemap_scan(&self) -> Enabled {
4720 self.pagemap_scan
4721 }
4722
4723 /// Returns the configured
4724 /// [`PoolingAllocationConfig::total_core_instances`], if enabled.
4725 pub fn get_total_core_instances(&self) -> u32 {
4726 self.limits.total_core_instances
4727 }
4728
4729 /// Returns the configured
4730 /// [`PoolingAllocationConfig::total_component_instances`], if
4731 /// enabled.
4732 pub fn get_total_component_instances(&self) -> u32 {
4733 self.limits.total_component_instances
4734 }
4735
4736 /// Returns the configured
4737 /// [`PoolingAllocationConfig::total_memories`], if enabled.
4738 pub fn get_total_memories(&self) -> u32 {
4739 self.limits.total_memories
4740 }
4741
4742 /// Returns the configured
4743 /// [`PoolingAllocationConfig::total_tables`], if enabled.
4744 pub fn get_total_tables(&self) -> u32 {
4745 self.limits.total_tables
4746 }
4747
4748 /// Returns the configured
4749 /// [`PoolingAllocationConfig::total_stacks`], if enabled.
4750 pub fn get_total_stacks(&self) -> u32 {
4751 self.limits.total_stacks
4752 }
4753
4754 /// Returns the configured
4755 /// [`PoolingAllocationConfig::total_gc_heaps`], if enabled.
4756 pub fn get_total_gc_heaps(&self) -> u32 {
4757 self.limits.total_gc_heaps
4758 }
4759
4760 /// Returns the configured
4761 /// [`PoolingAllocationConfig::max_memory_size`], if enabled.
4762 pub fn get_max_memory_size(&self) -> usize {
4763 self.limits.max_memory_size
4764 }
4765
4766 /// Returns the configured
4767 /// [`PoolingAllocationConfig::table_elements`], if enabled.
4768 pub fn get_table_elements(&self) -> usize {
4769 self.limits.table_elements
4770 }
4771
4772 /// Returns the configured
4773 /// [`PoolingAllocationConfig::max_core_instance_size`], if enabled.
4774 pub fn get_max_core_instance_size(&self) -> usize {
4775 self.limits.core_instance_size
4776 }
4777
4778 /// Returns the configured
4779 /// [`PoolingAllocationConfig::max_component_instance_size`], if
4780 /// enabled.
4781 pub fn get_max_component_instance_size(&self) -> usize {
4782 self.limits.component_instance_size
4783 }
4784
4785 /// Returns the configured
4786 /// [`PoolingAllocationConfig::max_core_instances_per_component`], if
4787 /// enabled.
4788 pub fn get_max_core_instances_per_component(&self) -> u32 {
4789 self.limits.max_core_instances_per_component
4790 }
4791
4792 /// Returns the configured
4793 /// [`PoolingAllocationConfig::max_memories_per_component`], if
4794 /// enabled.
4795 pub fn get_max_memories_per_component(&self) -> u32 {
4796 self.limits.max_memories_per_component
4797 }
4798
4799 /// Returns the configured
4800 /// [`PoolingAllocationConfig::max_tables_per_component`], if enabled.
4801 pub fn get_max_tables_per_component(&self) -> u32 {
4802 self.limits.max_tables_per_component
4803 }
4804
4805 /// Returns the configured
4806 /// [`PoolingAllocationConfig::max_tables_per_module`], if enabled.
4807 pub fn get_max_tables_per_module(&self) -> u32 {
4808 self.limits.max_tables_per_module
4809 }
4810
4811 /// Returns the configured
4812 /// [`PoolingAllocationConfig::max_memories_per_module`], if enabled.
4813 pub fn get_max_memories_per_module(&self) -> u32 {
4814 self.limits.max_memories_per_module
4815 }
4816}
4817
4818#[cfg(feature = "std")]
4819fn detect_host_feature(feature: &str) -> Option<bool> {
4820 #[cfg(target_arch = "aarch64")]
4821 {
4822 return match feature {
4823 "lse" => Some(std::arch::is_aarch64_feature_detected!("lse")),
4824 "paca" => Some(std::arch::is_aarch64_feature_detected!("paca")),
4825 "fp16" => Some(std::arch::is_aarch64_feature_detected!("fp16")),
4826 "dotprod" => Some(std::arch::is_aarch64_feature_detected!("dotprod")),
4827 "i8mm" => Some(std::arch::is_aarch64_feature_detected!("i8mm")),
4828
4829 _ => None,
4830 };
4831 }
4832
4833 // `is_s390x_feature_detected` is nightly only for now, so use the
4834 // STORE FACILITY LIST EXTENDED instruction as a temporary measure.
4835 #[cfg(target_arch = "s390x")]
4836 {
4837 let mut facility_list: [u64; 4] = [0; 4];
4838 unsafe {
4839 core::arch::asm!(
4840 "stfle 0({})",
4841 in(reg_addr) facility_list.as_mut_ptr() ,
4842 inout("r0") facility_list.len() as u64 - 1 => _,
4843 options(nostack)
4844 );
4845 }
4846 let get_facility_bit = |n: usize| {
4847 // NOTE: bits are numbered from the left.
4848 facility_list[n / 64] & (1 << (63 - (n % 64))) != 0
4849 };
4850
4851 return match feature {
4852 "mie3" => Some(get_facility_bit(61)),
4853 "mie4" => Some(get_facility_bit(84)),
4854 "vxrs_ext2" => Some(get_facility_bit(148)),
4855 "vxrs_ext3" => Some(get_facility_bit(198)),
4856
4857 _ => None,
4858 };
4859 }
4860
4861 #[cfg(target_arch = "riscv64")]
4862 {
4863 return match feature {
4864 // due to `is_riscv64_feature_detected` is not stable.
4865 // we cannot use it. For now lie and say all features are always
4866 // found to keep tests working.
4867 _ => Some(true),
4868 };
4869 }
4870
4871 #[cfg(target_arch = "x86_64")]
4872 {
4873 return match feature {
4874 "cmpxchg16b" => Some(std::is_x86_feature_detected!("cmpxchg16b")),
4875 "sse3" => Some(std::is_x86_feature_detected!("sse3")),
4876 "ssse3" => Some(std::is_x86_feature_detected!("ssse3")),
4877 "sse4.1" => Some(std::is_x86_feature_detected!("sse4.1")),
4878 "sse4.2" => Some(std::is_x86_feature_detected!("sse4.2")),
4879 "popcnt" => Some(std::is_x86_feature_detected!("popcnt")),
4880 "avx" => Some(std::is_x86_feature_detected!("avx")),
4881 "avx2" => Some(std::is_x86_feature_detected!("avx2")),
4882 "fma" => Some(std::is_x86_feature_detected!("fma")),
4883 "avxvnni" => Some(std::is_x86_feature_detected!("avxvnni")),
4884 "bmi1" => Some(std::is_x86_feature_detected!("bmi1")),
4885 "bmi2" => Some(std::is_x86_feature_detected!("bmi2")),
4886 "avx512bitalg" => Some(std::is_x86_feature_detected!("avx512bitalg")),
4887 "avx512dq" => Some(std::is_x86_feature_detected!("avx512dq")),
4888 "avx512f" => Some(std::is_x86_feature_detected!("avx512f")),
4889 "avx512vl" => Some(std::is_x86_feature_detected!("avx512vl")),
4890 "avx512vbmi" => Some(std::is_x86_feature_detected!("avx512vbmi")),
4891 "avx512vnni" => Some(std::is_x86_feature_detected!("avx512vnni")),
4892 "lzcnt" => Some(std::is_x86_feature_detected!("lzcnt")),
4893
4894 _ => None,
4895 };
4896 }
4897
4898 #[allow(
4899 unreachable_code,
4900 reason = "reachable or not depending on if a target above matches"
4901 )]
4902 {
4903 let _ = feature;
4904 return None;
4905 }
4906}
4907
4908// What follows in this impl block is intended to be a somewhat-mechanical
4909// mostly-complete set of getters for relevant configuration options on
4910// `Config`. The `Config` type does not reflect a complete configuration so
4911// default values cannot be directly read from it. An `Engine`, however,
4912// represents a concrete and complete configuration with all default values
4913// fully specified. The purpose of these getters are then to perform a dual
4914// function of reflecting what was explicitly configured above as well as
4915// defaults that Wasmtime sets.
4916//
4917// The current pattern is:
4918//
4919// * All methods are `get_<config_name>`
4920// * Return values return `T` instead of `Option<T>` where possible unless the
4921// state for `T` is completely missing.
4922//
4923// This impl is primarily in service of
4924// `wasmtime_cli_flags::CommonOptions::from_engine` at this time, and CLI flags
4925// are not as comprehensive as `Config` options, but it's expected that the set
4926// will settle/grow over time.
4927impl Engine {
4928 /// Returns the configured [`Config::memory_may_move`] value.
4929 pub fn get_memory_may_move(&self) -> bool {
4930 self.tunables().memory_may_move
4931 }
4932
4933 /// Returns the configured [`Config::memory_reservation`] value.
4934 pub fn get_memory_reservation(&self) -> u64 {
4935 self.tunables().memory_reservation
4936 }
4937
4938 /// Returns the configured [`Config::memory_reservation_for_growth`] value.
4939 pub fn get_memory_reservation_for_growth(&self) -> u64 {
4940 self.tunables().memory_reservation_for_growth
4941 }
4942
4943 /// Returns the configured [`Config::memory_guard_size`] value.
4944 pub fn get_memory_guard_size(&self) -> u64 {
4945 self.tunables().memory_guard_size
4946 }
4947
4948 /// Returns the configured [`Config::gc_heap_may_move`] value.
4949 pub fn get_gc_heap_may_move(&self) -> bool {
4950 self.tunables().gc_heap_may_move
4951 }
4952
4953 /// Returns the configured [`Config::gc_heap_reservation`] value.
4954 pub fn get_gc_heap_reservation(&self) -> u64 {
4955 self.tunables().gc_heap_reservation
4956 }
4957
4958 /// Returns the configured [`Config::gc_heap_initial_size`] value.
4959 pub fn get_gc_heap_initial_size(&self) -> u64 {
4960 self.tunables().gc_heap_initial_size
4961 }
4962
4963 /// Returns the configured [`Config::gc_heap_reservation_for_growth`] value.
4964 pub fn get_gc_heap_reservation_for_growth(&self) -> u64 {
4965 self.tunables().gc_heap_reservation_for_growth
4966 }
4967
4968 /// Returns the configured [`Config::gc_heap_guard_size`] value.
4969 pub fn get_gc_heap_guard_size(&self) -> u64 {
4970 self.tunables().gc_heap_guard_size
4971 }
4972
4973 /// Returns the configured [`Config::guard_before_linear_memory`] value.
4974 pub fn get_guard_before_linear_memory(&self) -> bool {
4975 self.tunables().guard_before_linear_memory
4976 }
4977
4978 /// Returns the configured [`Config::table_lazy_init`] value.
4979 pub fn get_table_lazy_init(&self) -> bool {
4980 self.tunables().table_lazy_init
4981 }
4982
4983 /// Returns the configured [`Config::memory_init_cow`] value.
4984 pub fn get_memory_init_cow(&self) -> bool {
4985 self.tunables().memory_init_cow
4986 }
4987
4988 /// Returns the configured [`Config::memory_guaranteed_dense_image_size`] value.
4989 pub fn get_memory_guaranteed_dense_image_size(&self) -> u64 {
4990 self.config().memory_guaranteed_dense_image_size
4991 }
4992
4993 /// Returns the configured [`Config::signals_based_traps`] value.
4994 pub fn get_signals_based_traps(&self) -> bool {
4995 self.tunables().signals_based_traps
4996 }
4997
4998 /// Returns the configured [`Config::gc_zeal_alloc_counter`] value.
4999 pub fn get_gc_zeal_alloc_counter(&self) -> Option<core::num::NonZeroU32> {
5000 self.tunables().gc_zeal_alloc_counter
5001 }
5002
5003 /// Returns the configured [`Config::cranelift_opt_level`] value.
5004 pub fn get_cranelift_opt_level(&self) -> Option<OptLevel> {
5005 #[cfg(any(feature = "cranelift", feature = "winch"))]
5006 if let Some(compiler) = self.compiler() {
5007 let flags = compiler.flags();
5008 let (_, FlagValue::Enum(opt)) = flags.iter().find(|(f, _)| *f == "opt_level")? else {
5009 return None;
5010 };
5011 return match &opt[..] {
5012 "none" => Some(OptLevel::None),
5013 "speed" => Some(OptLevel::Speed),
5014 "speed_and_size" => Some(OptLevel::SpeedAndSize),
5015 _ => None,
5016 };
5017 }
5018 None
5019 }
5020
5021 /// Returns the configured [`Config::cranelift_regalloc_algorithm`] value.
5022 pub fn get_cranelift_regalloc_algorithm(&self) -> Option<RegallocAlgorithm> {
5023 #[cfg(any(feature = "cranelift", feature = "winch"))]
5024 if let Some(compiler) = self.compiler() {
5025 let flags = compiler.flags();
5026 let (_, FlagValue::Enum(opt)) =
5027 flags.iter().find(|(f, _)| *f == "regalloc_algorithm")?
5028 else {
5029 return None;
5030 };
5031 return match &opt[..] {
5032 "backtracking" => Some(RegallocAlgorithm::Backtracking),
5033 "single_pass" => Some(RegallocAlgorithm::SinglePass),
5034 _ => None,
5035 };
5036 }
5037 None
5038 }
5039
5040 /// Returns the configured [`Config::strategy`] value.
5041 pub fn get_strategy(&self) -> Option<Strategy> {
5042 self.config().get_strategy()
5043 }
5044
5045 /// Returns the configured [`Config::collector`] value.
5046 pub fn get_collector(&self) -> Option<Collector> {
5047 #[cfg(feature = "gc")]
5048 return Some(self.config().collector);
5049 #[cfg(not(feature = "gc"))]
5050 return None;
5051 }
5052
5053 /// Returns the configured [`Config::cranelift_debug_verifier`] value.
5054 pub fn get_cranelift_debug_verifier(&self) -> Option<bool> {
5055 #[cfg(any(feature = "cranelift", feature = "winch"))]
5056 if let Some(compiler) = self.compiler() {
5057 let flags = compiler.flags();
5058 let (_, FlagValue::Bool(b)) = flags.iter().find(|(f, _)| *f == "enable_verifier")?
5059 else {
5060 return None;
5061 };
5062 return Some(*b);
5063 }
5064 None
5065 }
5066
5067 /// Returns the configured [`Config::compiler_inlining`] value.
5068 pub fn get_compiler_inlining(&self) -> Inlining {
5069 self.tunables().inlining
5070 }
5071
5072 /// Returns the configured [`Config::native_unwind_info`] value.
5073 pub fn get_native_unwind_info(&self) -> Option<bool> {
5074 #[cfg(any(feature = "cranelift", feature = "winch"))]
5075 if let Some(compiler) = self.compiler() {
5076 let flags = compiler.flags();
5077 let (_, FlagValue::Bool(b)) = flags.iter().find(|(f, _)| *f == "unwind_info")? else {
5078 return None;
5079 };
5080 return Some(*b);
5081 }
5082 None
5083 }
5084
5085 /// Returns the configured [`Config::parallel_compilation`] value.
5086 pub fn get_parallel_compilation(&self) -> bool {
5087 self.config().parallel_compilation
5088 }
5089
5090 /// Returns the configured [`Config::metadata_for_internal_asserts`] value.
5091 pub fn get_metadata_for_internal_asserts(&self) -> bool {
5092 self.tunables().metadata_for_internal_asserts
5093 }
5094
5095 /// Returns the configured [`Config::metadata_for_gc_heap_corruption`] value.
5096 pub fn get_metadata_for_gc_heap_corruption(&self) -> bool {
5097 self.tunables().metadata_for_gc_heap_corruption
5098 }
5099
5100 /// Returns the runtime pooling allocator configuration, if the pooling
5101 /// allocator is in use.
5102 pub fn get_pooling_config(&self) -> Option<&PoolingAllocationConfig> {
5103 #[cfg(feature = "pooling-allocator")]
5104 {
5105 Some(self.allocator().as_pooling()?.config())
5106 }
5107 #[cfg(not(feature = "pooling-allocator"))]
5108 {
5109 None
5110 }
5111 }
5112
5113 /// Returns the configured wasm proposals enabled in this engine.
5114 pub fn get_wasm_features(&self) -> WasmFeatures {
5115 self.features()
5116 }
5117
5118 /// Returns the configured [`Config::async_stack_size`] value.
5119 pub fn get_async_stack_size(&self) -> usize {
5120 self.config().async_stack_size
5121 }
5122
5123 /// Returns the configured [`Config::async_stack_zeroing`] value.
5124 pub fn get_async_stack_zeroing(&self) -> bool {
5125 self.config().async_stack_zeroing
5126 }
5127
5128 /// Returns the configured [`Config::wasm_branch_hinting`] value.
5129 pub fn get_wasm_branch_hinting(&self) -> bool {
5130 self.tunables().branch_hinting
5131 }
5132
5133 /// Returns the configured [`Config::concurrency_support`] value.
5134 pub fn get_concurrency_support(&self) -> bool {
5135 self.tunables().concurrency_support
5136 }
5137
5138 /// Returns the configured [`Config::epoch_interruption`] value.
5139 pub fn get_epoch_interruption(&self) -> bool {
5140 self.tunables().epoch_interruption
5141 }
5142
5143 /// Returns the configured [`Config::consume_fuel`] value.
5144 pub fn get_consume_fuel(&self) -> bool {
5145 self.tunables().consume_fuel
5146 }
5147
5148 /// Returns the configured [`Config::max_wasm_stack`] value.
5149 pub fn get_max_wasm_stack(&self) -> usize {
5150 self.config().max_wasm_stack
5151 }
5152
5153 /// Returns the configured [`Config::cranelift_nan_canonicalization`] value.
5154 pub fn get_cranelift_nan_canonicalization(&self) -> Option<bool> {
5155 #[cfg(any(feature = "cranelift", feature = "winch"))]
5156 if let Some(compiler) = self.compiler() {
5157 let flags = compiler.flags();
5158 let (_, FlagValue::Bool(b)) = flags
5159 .iter()
5160 .find(|(f, _)| *f == "enable_nan_canonicalization")?
5161 else {
5162 return None;
5163 };
5164 return Some(*b);
5165 }
5166 None
5167 }
5168
5169 /// Returns the configured [`Config::relaxed_simd_deterministic`] value.
5170 pub fn get_relaxed_simd_deterministic(&self) -> bool {
5171 self.tunables().relaxed_simd_deterministic
5172 }
5173
5174 /// Returns the configured [`Config::shared_memory`] value.
5175 pub fn get_shared_memory(&self) -> bool {
5176 self.config().shared_memory
5177 }
5178
5179 /// Returns the configured [`Config::generate_address_map`] value.
5180 pub fn get_generate_address_map(&self) -> bool {
5181 self.tunables().generate_address_map
5182 }
5183
5184 /// Returns the configured [`Config::debug_info`] value.
5185 pub fn get_debug_info(&self) -> bool {
5186 self.tunables().debug_native
5187 }
5188
5189 /// Returns the configured [`Config::guest_debug`] value.
5190 pub fn get_guest_debug(&self) -> bool {
5191 self.tunables().debug_guest
5192 }
5193
5194 /// Returns the configured [`Config::debug_symbols`] value.
5195 pub fn get_debug_symbols(&self) -> bool {
5196 self.tunables().debug_symbols
5197 }
5198
5199 /// Returns the configured [`Config::wasm_backtrace_max_frames`] value.
5200 pub fn get_wasm_backtrace_max_frames(&self) -> usize {
5201 self.config()
5202 .wasm_backtrace_max_frames
5203 .map(|f| f.get())
5204 .unwrap_or(0)
5205 }
5206
5207 /// Returns the configured [`Config::target`] value.
5208 pub fn get_target(&self) -> Option<String> {
5209 #[cfg(any(feature = "cranelift", feature = "winch"))]
5210 if let Some(compiler) = self.compiler() {
5211 return Some(compiler.triple().to_string());
5212 }
5213 None
5214 }
5215
5216 /// Returns the enabled flags via [`Config::cranelift_flag_enable`].
5217 pub fn get_cranelift_flags_enabled(&self) -> impl Iterator<Item = &str> {
5218 #[cfg(any(feature = "cranelift", feature = "winch"))]
5219 if let Some(config) = &self.config().compiler_config {
5220 return config
5221 .flags
5222 .iter()
5223 .filter_map(|(k, v)| match v {
5224 UserSpecified::Yes => Some(k.as_str()),
5225 UserSpecified::No => None,
5226 })
5227 .collect::<Vec<_>>()
5228 .into_iter();
5229 }
5230
5231 Vec::new().into_iter()
5232 }
5233
5234 /// Returns the enabled flags via [`Config::cranelift_flag_set`].
5235 pub fn get_cranelift_flags_set(&self) -> impl Iterator<Item = (&str, &str)> {
5236 #[cfg(any(feature = "cranelift", feature = "winch"))]
5237 if let Some(config) = &self.config().compiler_config {
5238 return config
5239 .settings
5240 .iter()
5241 .filter_map(|(k, (v, s))| match s {
5242 UserSpecified::Yes => Some((k.as_str(), v.as_str())),
5243 UserSpecified::No => None,
5244 })
5245 .collect::<Vec<_>>()
5246 .into_iter();
5247 }
5248
5249 Vec::new().into_iter()
5250 }
5251}