Skip to main content

wasmtime/
config.rs

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