wasmtime_cli_flags/
lib.rs

1//! Contains the common Wasmtime command line interface (CLI) flags.
2
3use anyhow::{Context, Result};
4use clap::Parser;
5use serde::Deserialize;
6use std::{
7    fmt, fs,
8    path::{Path, PathBuf},
9    time::Duration,
10};
11use wasmtime::Config;
12
13pub mod opt;
14
15#[cfg(feature = "logging")]
16fn init_file_per_thread_logger(prefix: &'static str) {
17    file_per_thread_logger::initialize(prefix);
18    file_per_thread_logger::allow_uninitialized();
19
20    // Extending behavior of default spawner:
21    // https://docs.rs/rayon/1.1.0/rayon/struct.ThreadPoolBuilder.html#method.spawn_handler
22    // Source code says DefaultSpawner is implementation detail and
23    // shouldn't be used directly.
24    #[cfg(feature = "parallel-compilation")]
25    rayon::ThreadPoolBuilder::new()
26        .spawn_handler(move |thread| {
27            let mut b = std::thread::Builder::new();
28            if let Some(name) = thread.name() {
29                b = b.name(name.to_owned());
30            }
31            if let Some(stack_size) = thread.stack_size() {
32                b = b.stack_size(stack_size);
33            }
34            b.spawn(move || {
35                file_per_thread_logger::initialize(prefix);
36                thread.run()
37            })?;
38            Ok(())
39        })
40        .build_global()
41        .unwrap();
42}
43
44wasmtime_option_group! {
45    #[derive(PartialEq, Clone, Deserialize)]
46    #[serde(rename_all = "kebab-case", deny_unknown_fields)]
47    pub struct OptimizeOptions {
48        /// Optimization level of generated code (0-2, s; default: 2)
49        #[serde(default)]
50        #[serde(deserialize_with = "crate::opt::cli_parse_wrapper")]
51        pub opt_level: Option<wasmtime::OptLevel>,
52
53        /// Register allocator algorithm choice.
54        #[serde(default)]
55        #[serde(deserialize_with = "crate::opt::cli_parse_wrapper")]
56        pub regalloc_algorithm: Option<wasmtime::RegallocAlgorithm>,
57
58        /// Do not allow Wasm linear memories to move in the host process's
59        /// address space.
60        pub memory_may_move: Option<bool>,
61
62        /// Initial virtual memory allocation size for memories.
63        pub memory_reservation: Option<u64>,
64
65        /// Bytes to reserve at the end of linear memory for growth into.
66        pub memory_reservation_for_growth: Option<u64>,
67
68        /// Size, in bytes, of guard pages for linear memories.
69        pub memory_guard_size: Option<u64>,
70
71        /// Indicates whether an unmapped region of memory is placed before all
72        /// linear memories.
73        pub guard_before_linear_memory: Option<bool>,
74
75        /// Whether to initialize tables lazily, so that instantiation is
76        /// fast but indirect calls are a little slower. If no, tables are
77        /// initialized eagerly from any active element segments that apply to
78        /// them during instantiation. (default: yes)
79        pub table_lazy_init: Option<bool>,
80
81        /// Enable the pooling allocator, in place of the on-demand allocator.
82        pub pooling_allocator: Option<bool>,
83
84        /// The number of decommits to do per batch. A batch size of 1
85        /// effectively disables decommit batching. (default: 1)
86        pub pooling_decommit_batch_size: Option<usize>,
87
88        /// How many bytes to keep resident between instantiations for the
89        /// pooling allocator in linear memories.
90        pub pooling_memory_keep_resident: Option<usize>,
91
92        /// How many bytes to keep resident between instantiations for the
93        /// pooling allocator in tables.
94        pub pooling_table_keep_resident: Option<usize>,
95
96        /// Enable memory protection keys for the pooling allocator; this can
97        /// optimize the size of memory slots.
98        #[serde(default)]
99        #[serde(deserialize_with = "crate::opt::cli_parse_wrapper")]
100        pub pooling_memory_protection_keys: Option<wasmtime::MpkEnabled>,
101
102        /// Sets an upper limit on how many memory protection keys (MPK) Wasmtime
103        /// will use. (default: 16)
104        pub pooling_max_memory_protection_keys: Option<usize>,
105
106        /// Configure attempting to initialize linear memory via a
107        /// copy-on-write mapping (default: yes)
108        pub memory_init_cow: Option<bool>,
109
110        /// Threshold below which CoW images are guaranteed to be used and be
111        /// dense.
112        pub memory_guaranteed_dense_image_size: Option<u64>,
113
114        /// The maximum number of WebAssembly instances which can be created
115        /// with the pooling allocator.
116        pub pooling_total_core_instances: Option<u32>,
117
118        /// The maximum number of WebAssembly components which can be created
119        /// with the pooling allocator.
120        pub pooling_total_component_instances: Option<u32>,
121
122        /// The maximum number of WebAssembly memories which can be created with
123        /// the pooling allocator.
124        pub pooling_total_memories: Option<u32>,
125
126        /// The maximum number of WebAssembly tables which can be created with
127        /// the pooling allocator.
128        pub pooling_total_tables: Option<u32>,
129
130        /// The maximum number of WebAssembly stacks which can be created with
131        /// the pooling allocator.
132        pub pooling_total_stacks: Option<u32>,
133
134        /// The maximum runtime size of each linear memory in the pooling
135        /// allocator, in bytes.
136        pub pooling_max_memory_size: Option<usize>,
137
138        /// The maximum table elements for any table defined in a module when
139        /// using the pooling allocator.
140        pub pooling_table_elements: Option<usize>,
141
142        /// The maximum size, in bytes, allocated for a core instance's metadata
143        /// when using the pooling allocator.
144        pub pooling_max_core_instance_size: Option<usize>,
145
146        /// Configures the maximum number of "unused warm slots" to retain in the
147        /// pooling allocator. (default: 100)
148        pub pooling_max_unused_warm_slots: Option<u32>,
149
150        /// How much memory, in bytes, to keep resident for async stacks allocated
151        /// with the pooling allocator. (default: 0)
152        pub pooling_async_stack_keep_resident: Option<usize>,
153
154        /// The maximum size, in bytes, allocated for a component instance's
155        /// `VMComponentContext` metadata. (default: 1MiB)
156        pub pooling_max_component_instance_size: Option<usize>,
157
158        /// The maximum number of core instances a single component may contain
159        /// (default is unlimited).
160        pub pooling_max_core_instances_per_component: Option<u32>,
161
162        /// The maximum number of Wasm linear memories that a single component may
163        /// transitively contain (default is unlimited).
164        pub pooling_max_memories_per_component: Option<u32>,
165
166        /// The maximum number of tables that a single component may transitively
167        /// contain (default is unlimited).
168        pub pooling_max_tables_per_component: Option<u32>,
169
170        /// The maximum number of defined tables for a core module. (default: 1)
171        pub pooling_max_tables_per_module: Option<u32>,
172
173        /// The maximum number of defined linear memories for a module. (default: 1)
174        pub pooling_max_memories_per_module: Option<u32>,
175
176        /// The maximum number of concurrent GC heaps supported. (default: 1000)
177        pub pooling_total_gc_heaps: Option<u32>,
178
179        /// Enable or disable the use of host signal handlers for traps.
180        pub signals_based_traps: Option<bool>,
181
182        /// DEPRECATED: Use `-Cmemory-guard-size=N` instead.
183        pub dynamic_memory_guard_size: Option<u64>,
184
185        /// DEPRECATED: Use `-Cmemory-guard-size=N` instead.
186        pub static_memory_guard_size: Option<u64>,
187
188        /// DEPRECATED: Use `-Cmemory-may-move` instead.
189        pub static_memory_forced: Option<bool>,
190
191        /// DEPRECATED: Use `-Cmemory-reservation=N` instead.
192        pub static_memory_maximum_size: Option<u64>,
193
194        /// DEPRECATED: Use `-Cmemory-reservation-for-growth=N` instead.
195        pub dynamic_memory_reserved_for_growth: Option<u64>,
196    }
197
198    enum Optimize {
199        ...
200    }
201}
202
203wasmtime_option_group! {
204    #[derive(PartialEq, Clone, Deserialize)]
205    #[serde(rename_all = "kebab-case", deny_unknown_fields)]
206    pub struct CodegenOptions {
207        /// Either `cranelift` or `winch`.
208        ///
209        /// Currently only `cranelift` and `winch` are supported, but not all
210        /// builds of Wasmtime have both built in.
211        #[serde(default)]
212        #[serde(deserialize_with = "crate::opt::cli_parse_wrapper")]
213        pub compiler: Option<wasmtime::Strategy>,
214        /// Which garbage collector to use: `drc` or `null`.
215        ///
216        /// `drc` is the deferred reference-counting collector.
217        ///
218        /// `null` is the null garbage collector, which does not collect any
219        /// garbage.
220        ///
221        /// Note that not all builds of Wasmtime will have support for garbage
222        /// collection included.
223        #[serde(default)]
224        #[serde(deserialize_with = "crate::opt::cli_parse_wrapper")]
225        pub collector: Option<wasmtime::Collector>,
226        /// Enable Cranelift's internal debug verifier (expensive)
227        pub cranelift_debug_verifier: Option<bool>,
228        /// Whether or not to enable caching of compiled modules.
229        pub cache: Option<bool>,
230        /// Configuration for compiled module caching.
231        pub cache_config: Option<String>,
232        /// Whether or not to enable parallel compilation of modules.
233        pub parallel_compilation: Option<bool>,
234        /// Whether to enable proof-carrying code (PCC)-based validation.
235        pub pcc: Option<bool>,
236        /// Controls whether native unwind information is present in compiled
237        /// object files.
238        pub native_unwind_info: Option<bool>,
239
240        #[prefixed = "cranelift"]
241        #[serde(default)]
242        /// Set a cranelift-specific option. Use `wasmtime settings` to see
243        /// all.
244        pub cranelift: Vec<(String, Option<String>)>,
245    }
246
247    enum Codegen {
248        ...
249    }
250}
251
252wasmtime_option_group! {
253    #[derive(PartialEq, Clone, Deserialize)]
254    #[serde(rename_all = "kebab-case", deny_unknown_fields)]
255    pub struct DebugOptions {
256        /// Enable generation of DWARF debug information in compiled code.
257        pub debug_info: Option<bool>,
258        /// Configure whether compiled code can map native addresses to wasm.
259        pub address_map: Option<bool>,
260        /// Configure whether logging is enabled.
261        pub logging: Option<bool>,
262        /// Configure whether logs are emitted to files
263        pub log_to_files: Option<bool>,
264        /// Enable coredump generation to this file after a WebAssembly trap.
265        pub coredump: Option<String>,
266    }
267
268    enum Debug {
269        ...
270    }
271}
272
273wasmtime_option_group! {
274    #[derive(PartialEq, Clone, Deserialize)]
275    #[serde(rename_all = "kebab-case", deny_unknown_fields)]
276    pub struct WasmOptions {
277        /// Enable canonicalization of all NaN values.
278        pub nan_canonicalization: Option<bool>,
279        /// Enable execution fuel with N units fuel, trapping after running out
280        /// of fuel.
281        ///
282        /// Most WebAssembly instructions consume 1 unit of fuel. Some
283        /// instructions, such as `nop`, `drop`, `block`, and `loop`, consume 0
284        /// units, as any execution cost associated with them involves other
285        /// instructions which do consume fuel.
286        pub fuel: Option<u64>,
287        /// Yield when a global epoch counter changes, allowing for async
288        /// operation without blocking the executor.
289        pub epoch_interruption: Option<bool>,
290        /// Maximum stack size, in bytes, that wasm is allowed to consume before a
291        /// stack overflow is reported.
292        pub max_wasm_stack: Option<usize>,
293        /// Stack size, in bytes, that will be allocated for async stacks.
294        ///
295        /// Note that this must be larger than `max-wasm-stack` and the
296        /// difference between the two is how much stack the host has to execute
297        /// on.
298        pub async_stack_size: Option<usize>,
299        /// Configures whether or not stacks used for async futures are zeroed
300        /// before (re)use as a defense-in-depth mechanism. (default: false)
301        pub async_stack_zeroing: Option<bool>,
302        /// Allow unknown exports when running commands.
303        pub unknown_exports_allow: Option<bool>,
304        /// Allow the main module to import unknown functions, using an
305        /// implementation that immediately traps, when running commands.
306        pub unknown_imports_trap: Option<bool>,
307        /// Allow the main module to import unknown functions, using an
308        /// implementation that returns default values, when running commands.
309        pub unknown_imports_default: Option<bool>,
310        /// Enables memory error checking. (see wmemcheck.md for more info)
311        pub wmemcheck: Option<bool>,
312        /// Maximum size, in bytes, that a linear memory is allowed to reach.
313        ///
314        /// Growth beyond this limit will cause `memory.grow` instructions in
315        /// WebAssembly modules to return -1 and fail.
316        pub max_memory_size: Option<usize>,
317        /// Maximum size, in table elements, that a table is allowed to reach.
318        pub max_table_elements: Option<usize>,
319        /// Maximum number of WebAssembly instances allowed to be created.
320        pub max_instances: Option<usize>,
321        /// Maximum number of WebAssembly tables allowed to be created.
322        pub max_tables: Option<usize>,
323        /// Maximum number of WebAssembly linear memories allowed to be created.
324        pub max_memories: Option<usize>,
325        /// Force a trap to be raised on `memory.grow` and `table.grow` failure
326        /// instead of returning -1 from these instructions.
327        ///
328        /// This is not necessarily a spec-compliant option to enable but can be
329        /// useful for tracking down a backtrace of what is requesting so much
330        /// memory, for example.
331        pub trap_on_grow_failure: Option<bool>,
332        /// Maximum execution time of wasm code before timing out (1, 2s, 100ms, etc)
333        pub timeout: Option<Duration>,
334        /// Configures support for all WebAssembly proposals implemented.
335        pub all_proposals: Option<bool>,
336        /// Configure support for the bulk memory proposal.
337        pub bulk_memory: Option<bool>,
338        /// Configure support for the multi-memory proposal.
339        pub multi_memory: Option<bool>,
340        /// Configure support for the multi-value proposal.
341        pub multi_value: Option<bool>,
342        /// Configure support for the reference-types proposal.
343        pub reference_types: Option<bool>,
344        /// Configure support for the simd proposal.
345        pub simd: Option<bool>,
346        /// Configure support for the relaxed-simd proposal.
347        pub relaxed_simd: Option<bool>,
348        /// Configure forcing deterministic and host-independent behavior of
349        /// the relaxed-simd instructions.
350        ///
351        /// By default these instructions may have architecture-specific behavior as
352        /// allowed by the specification, but this can be used to force the behavior
353        /// of these instructions to match the deterministic behavior classified in
354        /// the specification. Note that enabling this option may come at a
355        /// performance cost.
356        pub relaxed_simd_deterministic: Option<bool>,
357        /// Configure support for the tail-call proposal.
358        pub tail_call: Option<bool>,
359        /// Configure support for the threads proposal.
360        pub threads: Option<bool>,
361        /// Configure support for the shared-everything-threads proposal.
362        pub shared_everything_threads: Option<bool>,
363        /// Configure support for the memory64 proposal.
364        pub memory64: Option<bool>,
365        /// Configure support for the component-model proposal.
366        pub component_model: Option<bool>,
367        /// Component model support for async lifting/lowering.
368        pub component_model_async: Option<bool>,
369        /// Component model support for async lifting/lowering: this corresponds
370        /// to the 🚝 emoji in the component model specification.
371        pub component_model_async_builtins: Option<bool>,
372        /// Component model support for async lifting/lowering: this corresponds
373        /// to the 🚟 emoji in the component model specification.
374        pub component_model_async_stackful: Option<bool>,
375        /// Component model support for `error-context`: this corresponds
376        /// to the 📝 emoji in the component model specification.
377        pub component_model_error_context: Option<bool>,
378        /// GC support in the component model: this corresponds to the 🛸 emoji
379        /// in the component model specification.
380        pub component_model_gc: Option<bool>,
381        /// Configure support for the function-references proposal.
382        pub function_references: Option<bool>,
383        /// Configure support for the stack-switching proposal.
384        pub stack_switching: Option<bool>,
385        /// Configure support for the GC proposal.
386        pub gc: Option<bool>,
387        /// Configure support for the custom-page-sizes proposal.
388        pub custom_page_sizes: Option<bool>,
389        /// Configure support for the wide-arithmetic proposal.
390        pub wide_arithmetic: Option<bool>,
391        /// Configure support for the extended-const proposal.
392        pub extended_const: Option<bool>,
393        /// Configure support for the exceptions proposal.
394        pub exceptions: Option<bool>,
395        /// DEPRECATED: Configure support for the legacy exceptions proposal.
396        pub legacy_exceptions: Option<bool>,
397    }
398
399    enum Wasm {
400        ...
401    }
402}
403
404wasmtime_option_group! {
405    #[derive(PartialEq, Clone, Deserialize)]
406    #[serde(rename_all = "kebab-case", deny_unknown_fields)]
407    pub struct WasiOptions {
408        /// Enable support for WASI CLI APIs, including filesystems, sockets, clocks, and random.
409        pub cli: Option<bool>,
410        /// Enable WASI APIs marked as: @unstable(feature = cli-exit-with-code)
411        pub cli_exit_with_code: Option<bool>,
412        /// Deprecated alias for `cli`
413        pub common: Option<bool>,
414        /// Enable support for WASI neural network imports (experimental)
415        pub nn: Option<bool>,
416        /// Enable support for WASI threading imports (experimental). Implies preview2=false.
417        pub threads: Option<bool>,
418        /// Enable support for WASI HTTP imports
419        pub http: Option<bool>,
420        /// Number of distinct write calls to the outgoing body's output-stream
421        /// that the implementation will buffer.
422        /// Default: 1.
423        pub http_outgoing_body_buffer_chunks: Option<usize>,
424        /// Maximum size allowed in a write call to the outgoing body's output-stream.
425        /// Default: 1024 * 1024.
426        pub http_outgoing_body_chunk_size: Option<usize>,
427        /// Enable support for WASI config imports (experimental)
428        pub config: Option<bool>,
429        /// Enable support for WASI key-value imports (experimental)
430        pub keyvalue: Option<bool>,
431        /// Inherit environment variables and file descriptors following the
432        /// systemd listen fd specification (UNIX only) (legacy wasip1
433        /// implementation only)
434        pub listenfd: Option<bool>,
435        /// Grant access to the given TCP listen socket (experimental, legacy
436        /// wasip1 implementation only)
437        #[serde(default)]
438        pub tcplisten: Vec<String>,
439        /// Enable support for WASI TLS (Transport Layer Security) imports (experimental)
440        pub tls: Option<bool>,
441        /// Implement WASI Preview1 using new Preview2 implementation (true, default) or legacy
442        /// implementation (false)
443        pub preview2: Option<bool>,
444        /// Pre-load machine learning graphs (i.e., models) for use by wasi-nn.
445        ///
446        /// Each use of the flag will preload a ML model from the host directory
447        /// using the given model encoding. The model will be mapped to the
448        /// directory name: e.g., `--wasi-nn-graph openvino:/foo/bar` will preload
449        /// an OpenVINO model named `bar`. Note that which model encodings are
450        /// available is dependent on the backends implemented in the
451        /// `wasmtime_wasi_nn` crate.
452        #[serde(skip)]
453        pub nn_graph: Vec<WasiNnGraph>,
454        /// Flag for WASI preview2 to inherit the host's network within the
455        /// guest so it has full access to all addresses/ports/etc.
456        pub inherit_network: Option<bool>,
457        /// Indicates whether `wasi:sockets/ip-name-lookup` is enabled or not.
458        pub allow_ip_name_lookup: Option<bool>,
459        /// Indicates whether `wasi:sockets` TCP support is enabled or not.
460        pub tcp: Option<bool>,
461        /// Indicates whether `wasi:sockets` UDP support is enabled or not.
462        pub udp: Option<bool>,
463        /// Enable WASI APIs marked as: @unstable(feature = network-error-code)
464        pub network_error_code: Option<bool>,
465        /// Allows imports from the `wasi_unstable` core wasm module.
466        pub preview0: Option<bool>,
467        /// Inherit all environment variables from the parent process.
468        ///
469        /// This option can be further overwritten with `--env` flags.
470        pub inherit_env: Option<bool>,
471        /// Pass a wasi config variable to the program.
472        #[serde(skip)]
473        pub config_var: Vec<KeyValuePair>,
474        /// Preset data for the In-Memory provider of WASI key-value API.
475        #[serde(skip)]
476        pub keyvalue_in_memory_data: Vec<KeyValuePair>,
477    }
478
479    enum Wasi {
480        ...
481    }
482}
483
484#[derive(Debug, Clone, PartialEq)]
485pub struct WasiNnGraph {
486    pub format: String,
487    pub dir: String,
488}
489
490#[derive(Debug, Clone, PartialEq)]
491pub struct KeyValuePair {
492    pub key: String,
493    pub value: String,
494}
495
496/// Common options for commands that translate WebAssembly modules
497#[derive(Parser, Clone, Deserialize)]
498#[serde(deny_unknown_fields)]
499pub struct CommonOptions {
500    // These options groups are used to parse `-O` and such options but aren't
501    // the raw form consumed by the CLI. Instead they're pushed into the `pub`
502    // fields below as part of the `configure` method.
503    //
504    // Ideally clap would support `pub opts: OptimizeOptions` and parse directly
505    // into that but it does not appear to do so for multiple `-O` flags for
506    // now.
507    /// Optimization and tuning related options for wasm performance, `-O help` to
508    /// see all.
509    #[arg(short = 'O', long = "optimize", value_name = "KEY[=VAL[,..]]")]
510    #[serde(skip)]
511    opts_raw: Vec<opt::CommaSeparated<Optimize>>,
512
513    /// Codegen-related configuration options, `-C help` to see all.
514    #[arg(short = 'C', long = "codegen", value_name = "KEY[=VAL[,..]]")]
515    #[serde(skip)]
516    codegen_raw: Vec<opt::CommaSeparated<Codegen>>,
517
518    /// Debug-related configuration options, `-D help` to see all.
519    #[arg(short = 'D', long = "debug", value_name = "KEY[=VAL[,..]]")]
520    #[serde(skip)]
521    debug_raw: Vec<opt::CommaSeparated<Debug>>,
522
523    /// Options for configuring semantic execution of WebAssembly, `-W help` to see
524    /// all.
525    #[arg(short = 'W', long = "wasm", value_name = "KEY[=VAL[,..]]")]
526    #[serde(skip)]
527    wasm_raw: Vec<opt::CommaSeparated<Wasm>>,
528
529    /// Options for configuring WASI and its proposals, `-S help` to see all.
530    #[arg(short = 'S', long = "wasi", value_name = "KEY[=VAL[,..]]")]
531    #[serde(skip)]
532    wasi_raw: Vec<opt::CommaSeparated<Wasi>>,
533
534    // These fields are filled in by the `configure` method below via the
535    // options parsed from the CLI above. This is what the CLI should use.
536    #[arg(skip)]
537    #[serde(skip)]
538    configured: bool,
539
540    #[arg(skip)]
541    #[serde(rename = "optimize", default)]
542    pub opts: OptimizeOptions,
543
544    #[arg(skip)]
545    #[serde(rename = "codegen", default)]
546    pub codegen: CodegenOptions,
547
548    #[arg(skip)]
549    #[serde(rename = "debug", default)]
550    pub debug: DebugOptions,
551
552    #[arg(skip)]
553    #[serde(rename = "wasm", default)]
554    pub wasm: WasmOptions,
555
556    #[arg(skip)]
557    #[serde(rename = "wasi", default)]
558    pub wasi: WasiOptions,
559
560    /// The target triple; default is the host triple
561    #[arg(long, value_name = "TARGET")]
562    #[serde(skip)]
563    pub target: Option<String>,
564
565    /// Use the specified TOML configuration file.
566    /// This TOML configuration file can provide same configuration options as the
567    /// `--optimize`, `--codgen`, `--debug`, `--wasm`, `--wasi` CLI options, with a couple exceptions.
568    ///
569    /// Additional options specified on the command line will take precedent over options loaded from
570    /// this TOML file.
571    #[arg(long = "config", value_name = "FILE")]
572    #[serde(skip)]
573    pub config: Option<PathBuf>,
574}
575
576macro_rules! match_feature {
577    (
578        [$feat:tt : $config:expr]
579        $val:ident => $e:expr,
580        $p:pat => err,
581    ) => {
582        #[cfg(feature = $feat)]
583        {
584            if let Some($val) = $config {
585                $e;
586            }
587        }
588        #[cfg(not(feature = $feat))]
589        {
590            if let Some($p) = $config {
591                anyhow::bail!(concat!("support for ", $feat, " disabled at compile time"));
592            }
593        }
594    };
595}
596
597impl CommonOptions {
598    /// Creates a blank new set of [`CommonOptions`] that can be configured.
599    pub fn new() -> CommonOptions {
600        CommonOptions {
601            opts_raw: Vec::new(),
602            codegen_raw: Vec::new(),
603            debug_raw: Vec::new(),
604            wasm_raw: Vec::new(),
605            wasi_raw: Vec::new(),
606            configured: true,
607            opts: Default::default(),
608            codegen: Default::default(),
609            debug: Default::default(),
610            wasm: Default::default(),
611            wasi: Default::default(),
612            target: None,
613            config: None,
614        }
615    }
616
617    fn configure(&mut self) -> Result<()> {
618        if self.configured {
619            return Ok(());
620        }
621        self.configured = true;
622        if let Some(toml_config_path) = &self.config {
623            let toml_options = CommonOptions::from_file(toml_config_path)?;
624            self.opts = toml_options.opts;
625            self.codegen = toml_options.codegen;
626            self.debug = toml_options.debug;
627            self.wasm = toml_options.wasm;
628            self.wasi = toml_options.wasi;
629        }
630        self.opts.configure_with(&self.opts_raw);
631        self.codegen.configure_with(&self.codegen_raw);
632        self.debug.configure_with(&self.debug_raw);
633        self.wasm.configure_with(&self.wasm_raw);
634        self.wasi.configure_with(&self.wasi_raw);
635        Ok(())
636    }
637
638    pub fn init_logging(&mut self) -> Result<()> {
639        self.configure()?;
640        if self.debug.logging == Some(false) {
641            return Ok(());
642        }
643        #[cfg(feature = "logging")]
644        if self.debug.log_to_files == Some(true) {
645            let prefix = "wasmtime.dbg.";
646            init_file_per_thread_logger(prefix);
647        } else {
648            use std::io::IsTerminal;
649            use tracing_subscriber::{EnvFilter, FmtSubscriber};
650            let builder = FmtSubscriber::builder()
651                .with_writer(std::io::stderr)
652                .with_env_filter(EnvFilter::from_env("WASMTIME_LOG"))
653                .with_ansi(std::io::stderr().is_terminal());
654            if std::env::var("WASMTIME_LOG_NO_CONTEXT").is_ok_and(|value| value.eq("1")) {
655                builder
656                    .with_level(false)
657                    .with_target(false)
658                    .without_time()
659                    .init()
660            } else {
661                builder.init();
662            }
663        }
664        #[cfg(not(feature = "logging"))]
665        if self.debug.log_to_files == Some(true) || self.debug.logging == Some(true) {
666            anyhow::bail!("support for logging disabled at compile time");
667        }
668        Ok(())
669    }
670
671    pub fn config(&mut self, pooling_allocator_default: Option<bool>) -> Result<Config> {
672        self.configure()?;
673        let mut config = Config::new();
674
675        match_feature! {
676            ["cranelift" : self.codegen.compiler]
677            strategy => config.strategy(strategy),
678            _ => err,
679        }
680        match_feature! {
681            ["gc" : self.codegen.collector]
682            collector => config.collector(collector),
683            _ => err,
684        }
685        if let Some(target) = &self.target {
686            config.target(target)?;
687        }
688        match_feature! {
689            ["cranelift" : self.codegen.cranelift_debug_verifier]
690            enable => config.cranelift_debug_verifier(enable),
691            true => err,
692        }
693        if let Some(enable) = self.debug.debug_info {
694            config.debug_info(enable);
695        }
696        if self.debug.coredump.is_some() {
697            #[cfg(feature = "coredump")]
698            config.coredump_on_trap(true);
699            #[cfg(not(feature = "coredump"))]
700            anyhow::bail!("support for coredumps disabled at compile time");
701        }
702        match_feature! {
703            ["cranelift" : self.opts.opt_level]
704            level => config.cranelift_opt_level(level),
705            _ => err,
706        }
707        match_feature! {
708            ["cranelift": self.opts.regalloc_algorithm]
709            algo => config.cranelift_regalloc_algorithm(algo),
710            _ => err,
711        }
712        match_feature! {
713            ["cranelift" : self.wasm.nan_canonicalization]
714            enable => config.cranelift_nan_canonicalization(enable),
715            true => err,
716        }
717        match_feature! {
718            ["cranelift" : self.codegen.pcc]
719            enable => config.cranelift_pcc(enable),
720            true => err,
721        }
722
723        self.enable_wasm_features(&mut config)?;
724
725        #[cfg(feature = "cranelift")]
726        for (name, value) in self.codegen.cranelift.iter() {
727            let name = name.replace('-', "_");
728            unsafe {
729                match value {
730                    Some(val) => {
731                        config.cranelift_flag_set(&name, val);
732                    }
733                    None => {
734                        config.cranelift_flag_enable(&name);
735                    }
736                }
737            }
738        }
739        #[cfg(not(feature = "cranelift"))]
740        if !self.codegen.cranelift.is_empty() {
741            anyhow::bail!("support for cranelift disabled at compile time");
742        }
743
744        #[cfg(feature = "cache")]
745        if self.codegen.cache != Some(false) {
746            use wasmtime::Cache;
747            let cache = match &self.codegen.cache_config {
748                Some(path) => Cache::from_file(Some(Path::new(path)))?,
749                None => Cache::from_file(None)?,
750            };
751            config.cache(Some(cache));
752        }
753        #[cfg(not(feature = "cache"))]
754        if self.codegen.cache == Some(true) {
755            anyhow::bail!("support for caching disabled at compile time");
756        }
757
758        match_feature! {
759            ["parallel-compilation" : self.codegen.parallel_compilation]
760            enable => config.parallel_compilation(enable),
761            true => err,
762        }
763
764        let memory_reservation = self
765            .opts
766            .memory_reservation
767            .or(self.opts.static_memory_maximum_size);
768        if let Some(size) = memory_reservation {
769            config.memory_reservation(size);
770        }
771
772        if let Some(enable) = self.opts.static_memory_forced {
773            config.memory_may_move(!enable);
774        }
775        if let Some(enable) = self.opts.memory_may_move {
776            config.memory_may_move(enable);
777        }
778
779        let memory_guard_size = self
780            .opts
781            .static_memory_guard_size
782            .or(self.opts.dynamic_memory_guard_size)
783            .or(self.opts.memory_guard_size);
784        if let Some(size) = memory_guard_size {
785            config.memory_guard_size(size);
786        }
787
788        let mem_for_growth = self
789            .opts
790            .memory_reservation_for_growth
791            .or(self.opts.dynamic_memory_reserved_for_growth);
792        if let Some(size) = mem_for_growth {
793            config.memory_reservation_for_growth(size);
794        }
795        if let Some(enable) = self.opts.guard_before_linear_memory {
796            config.guard_before_linear_memory(enable);
797        }
798        if let Some(enable) = self.opts.table_lazy_init {
799            config.table_lazy_init(enable);
800        }
801
802        // If fuel has been configured, set the `consume fuel` flag on the config.
803        if self.wasm.fuel.is_some() {
804            config.consume_fuel(true);
805        }
806
807        if let Some(enable) = self.wasm.epoch_interruption {
808            config.epoch_interruption(enable);
809        }
810        if let Some(enable) = self.debug.address_map {
811            config.generate_address_map(enable);
812        }
813        if let Some(enable) = self.opts.memory_init_cow {
814            config.memory_init_cow(enable);
815        }
816        if let Some(size) = self.opts.memory_guaranteed_dense_image_size {
817            config.memory_guaranteed_dense_image_size(size);
818        }
819        if let Some(enable) = self.opts.signals_based_traps {
820            config.signals_based_traps(enable);
821        }
822        if let Some(enable) = self.codegen.native_unwind_info {
823            config.native_unwind_info(enable);
824        }
825
826        // async_stack_size enabled by either async or stack-switching, so
827        // cannot directly use match_feature!
828        #[cfg(any(feature = "async", feature = "stack-switching"))]
829        {
830            if let Some(size) = self.wasm.async_stack_size {
831                config.async_stack_size(size);
832            }
833        }
834        #[cfg(not(any(feature = "async", feature = "stack-switching")))]
835        {
836            if let Some(_size) = self.wasm.async_stack_size {
837                anyhow::bail!(concat!(
838                    "support for async/stack-switching disabled at compile time"
839                ));
840            }
841        }
842
843        match_feature! {
844            ["pooling-allocator" : self.opts.pooling_allocator.or(pooling_allocator_default)]
845            enable => {
846                if enable {
847                    let mut cfg = wasmtime::PoolingAllocationConfig::default();
848                    if let Some(size) = self.opts.pooling_memory_keep_resident {
849                        cfg.linear_memory_keep_resident(size);
850                    }
851                    if let Some(size) = self.opts.pooling_table_keep_resident {
852                        cfg.table_keep_resident(size);
853                    }
854                    if let Some(limit) = self.opts.pooling_total_core_instances {
855                        cfg.total_core_instances(limit);
856                    }
857                    if let Some(limit) = self.opts.pooling_total_component_instances {
858                        cfg.total_component_instances(limit);
859                    }
860                    if let Some(limit) = self.opts.pooling_total_memories {
861                        cfg.total_memories(limit);
862                    }
863                    if let Some(limit) = self.opts.pooling_total_tables {
864                        cfg.total_tables(limit);
865                    }
866                    if let Some(limit) = self.opts.pooling_table_elements
867                        .or(self.wasm.max_table_elements)
868                    {
869                        cfg.table_elements(limit);
870                    }
871                    if let Some(limit) = self.opts.pooling_max_core_instance_size {
872                        cfg.max_core_instance_size(limit);
873                    }
874                    match_feature! {
875                        ["async" : self.opts.pooling_total_stacks]
876                        limit => cfg.total_stacks(limit),
877                        _ => err,
878                    }
879                    if let Some(max) = self.opts.pooling_max_memory_size
880                        .or(self.wasm.max_memory_size)
881                    {
882                        cfg.max_memory_size(max);
883                    }
884                    if let Some(size) = self.opts.pooling_decommit_batch_size {
885                        cfg.decommit_batch_size(size);
886                    }
887                    if let Some(max) = self.opts.pooling_max_unused_warm_slots {
888                        cfg.max_unused_warm_slots(max);
889                    }
890                    match_feature! {
891                        ["async" : self.opts.pooling_async_stack_keep_resident]
892                        size => cfg.async_stack_keep_resident(size),
893                        _ => err,
894                    }
895                    if let Some(max) = self.opts.pooling_max_component_instance_size {
896                        cfg.max_component_instance_size(max);
897                    }
898                    if let Some(max) = self.opts.pooling_max_core_instances_per_component {
899                        cfg.max_core_instances_per_component(max);
900                    }
901                    if let Some(max) = self.opts.pooling_max_memories_per_component {
902                        cfg.max_memories_per_component(max);
903                    }
904                    if let Some(max) = self.opts.pooling_max_tables_per_component {
905                        cfg.max_tables_per_component(max);
906                    }
907                    if let Some(max) = self.opts.pooling_max_tables_per_module {
908                        cfg.max_tables_per_module(max);
909                    }
910                    if let Some(max) = self.opts.pooling_max_memories_per_module {
911                        cfg.max_memories_per_module(max);
912                    }
913                    match_feature! {
914                        ["memory-protection-keys" : self.opts.pooling_memory_protection_keys]
915                        enable => cfg.memory_protection_keys(enable),
916                        _ => err,
917                    }
918                    match_feature! {
919                        ["memory-protection-keys" : self.opts.pooling_max_memory_protection_keys]
920                        max => cfg.max_memory_protection_keys(max),
921                        _ => err,
922                    }
923                    match_feature! {
924                        ["gc" : self.opts.pooling_total_gc_heaps]
925                        max => cfg.total_gc_heaps(max),
926                        _ => err,
927                    }
928                    config.allocation_strategy(wasmtime::InstanceAllocationStrategy::Pooling(cfg));
929                }
930            },
931            true => err,
932        }
933
934        if self.opts.pooling_memory_protection_keys.is_some()
935            && !self.opts.pooling_allocator.unwrap_or(false)
936        {
937            anyhow::bail!("memory protection keys require the pooling allocator");
938        }
939
940        if self.opts.pooling_max_memory_protection_keys.is_some()
941            && !self.opts.pooling_memory_protection_keys.is_some()
942        {
943            anyhow::bail!(
944                "max memory protection keys requires memory protection keys to be enabled"
945            );
946        }
947
948        match_feature! {
949            ["async" : self.wasm.async_stack_zeroing]
950            enable => config.async_stack_zeroing(enable),
951            _ => err,
952        }
953
954        if let Some(max) = self.wasm.max_wasm_stack {
955            config.max_wasm_stack(max);
956
957            // If `-Wasync-stack-size` isn't passed then automatically adjust it
958            // to the wasm stack size provided here too. That prevents the need
959            // to pass both when one can generally be inferred from the other.
960            #[cfg(any(feature = "async", feature = "stack-switching"))]
961            if self.wasm.async_stack_size.is_none() {
962                const DEFAULT_HOST_STACK: usize = 512 << 10;
963                config.async_stack_size(max + DEFAULT_HOST_STACK);
964            }
965        }
966
967        if let Some(enable) = self.wasm.relaxed_simd_deterministic {
968            config.relaxed_simd_deterministic(enable);
969        }
970        match_feature! {
971            ["cranelift" : self.wasm.wmemcheck]
972            enable => config.wmemcheck(enable),
973            true => err,
974        }
975
976        Ok(config)
977    }
978
979    pub fn enable_wasm_features(&self, config: &mut Config) -> Result<()> {
980        let all = self.wasm.all_proposals;
981
982        if let Some(enable) = self.wasm.simd.or(all) {
983            config.wasm_simd(enable);
984        }
985        if let Some(enable) = self.wasm.relaxed_simd.or(all) {
986            config.wasm_relaxed_simd(enable);
987        }
988        if let Some(enable) = self.wasm.bulk_memory.or(all) {
989            config.wasm_bulk_memory(enable);
990        }
991        if let Some(enable) = self.wasm.multi_value.or(all) {
992            config.wasm_multi_value(enable);
993        }
994        if let Some(enable) = self.wasm.tail_call.or(all) {
995            config.wasm_tail_call(enable);
996        }
997        if let Some(enable) = self.wasm.multi_memory.or(all) {
998            config.wasm_multi_memory(enable);
999        }
1000        if let Some(enable) = self.wasm.memory64.or(all) {
1001            config.wasm_memory64(enable);
1002        }
1003        if let Some(enable) = self.wasm.stack_switching {
1004            config.wasm_stack_switching(enable);
1005        }
1006        if let Some(enable) = self.wasm.custom_page_sizes.or(all) {
1007            config.wasm_custom_page_sizes(enable);
1008        }
1009        if let Some(enable) = self.wasm.wide_arithmetic.or(all) {
1010            config.wasm_wide_arithmetic(enable);
1011        }
1012        if let Some(enable) = self.wasm.extended_const.or(all) {
1013            config.wasm_extended_const(enable);
1014        }
1015        if let Some(enable) = self.wasm.exceptions.or(all) {
1016            config.wasm_exceptions(enable);
1017        }
1018        if let Some(enable) = self.wasm.legacy_exceptions.or(all) {
1019            #[expect(deprecated, reason = "forwarding CLI flag")]
1020            config.wasm_legacy_exceptions(enable);
1021        }
1022
1023        macro_rules! handle_conditionally_compiled {
1024            ($(($feature:tt, $field:tt, $method:tt))*) => ($(
1025                if let Some(enable) = self.wasm.$field.or(all) {
1026                    #[cfg(feature = $feature)]
1027                    config.$method(enable);
1028                    #[cfg(not(feature = $feature))]
1029                    if enable && all.is_none() {
1030                        anyhow::bail!("support for {} was disabled at compile-time", $feature);
1031                    }
1032                }
1033            )*)
1034        }
1035
1036        handle_conditionally_compiled! {
1037            ("component-model", component_model, wasm_component_model)
1038            ("component-model-async", component_model_async, wasm_component_model_async)
1039            ("component-model-async", component_model_async_builtins, wasm_component_model_async_builtins)
1040            ("component-model-async", component_model_async_stackful, wasm_component_model_async_stackful)
1041            ("component-model", component_model_error_context, wasm_component_model_error_context)
1042            ("threads", threads, wasm_threads)
1043            ("gc", gc, wasm_gc)
1044            ("gc", reference_types, wasm_reference_types)
1045            ("gc", function_references, wasm_function_references)
1046            ("stack-switching", stack_switching, wasm_stack_switching)
1047        }
1048
1049        if let Some(enable) = self.wasm.component_model_gc {
1050            #[cfg(all(feature = "component-model", feature = "gc"))]
1051            config.wasm_component_model_gc(enable);
1052            #[cfg(not(all(feature = "component-model", feature = "gc")))]
1053            if enable && all.is_none() {
1054                anyhow::bail!("support for `component-model-gc` was disabled at compile time")
1055            }
1056        }
1057
1058        Ok(())
1059    }
1060
1061    pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
1062        let path_ref = path.as_ref();
1063        let file_contents = fs::read_to_string(path_ref)
1064            .with_context(|| format!("failed to read config file: {path_ref:?}"))?;
1065        toml::from_str::<CommonOptions>(&file_contents)
1066            .with_context(|| format!("failed to parse TOML config file {path_ref:?}"))
1067    }
1068}
1069
1070#[cfg(test)]
1071mod tests {
1072    use wasmtime::{OptLevel, RegallocAlgorithm};
1073
1074    use super::*;
1075
1076    #[test]
1077    fn from_toml() {
1078        // empty toml
1079        let empty_toml = "";
1080        let mut common_options: CommonOptions = toml::from_str(empty_toml).unwrap();
1081        common_options.config(None).unwrap();
1082
1083        // basic toml
1084        let basic_toml = r#"
1085            [optimize]
1086            [codegen]
1087            [debug]
1088            [wasm]
1089            [wasi]
1090        "#;
1091        let mut common_options: CommonOptions = toml::from_str(basic_toml).unwrap();
1092        common_options.config(None).unwrap();
1093
1094        // toml with custom deserialization to match CLI flag parsing
1095        for (opt_value, expected) in [
1096            ("0", Some(OptLevel::None)),
1097            ("1", Some(OptLevel::Speed)),
1098            ("2", Some(OptLevel::Speed)),
1099            ("\"s\"", Some(OptLevel::SpeedAndSize)),
1100            ("\"hello\"", None), // should fail
1101            ("3", None),         // should fail
1102        ] {
1103            let toml = format!(
1104                r#"
1105                    [optimize]
1106                    opt-level = {opt_value}
1107                "#,
1108            );
1109            let parsed_opt_level = toml::from_str::<CommonOptions>(&toml)
1110                .ok()
1111                .and_then(|common_options| common_options.opts.opt_level);
1112
1113            assert_eq!(
1114                parsed_opt_level, expected,
1115                "Mismatch for input '{opt_value}'. Parsed: {parsed_opt_level:?}, Expected: {expected:?}"
1116            );
1117        }
1118
1119        // Regalloc algorithm
1120        for (regalloc_value, expected) in [
1121            ("\"backtracking\"", Some(RegallocAlgorithm::Backtracking)),
1122            ("\"hello\"", None), // should fail
1123            ("3", None),         // should fail
1124            ("true", None),      // should fail
1125        ] {
1126            let toml = format!(
1127                r#"
1128                    [optimize]
1129                    regalloc-algorithm = {regalloc_value}
1130                "#,
1131            );
1132            let parsed_regalloc_algorithm = toml::from_str::<CommonOptions>(&toml)
1133                .ok()
1134                .and_then(|common_options| common_options.opts.regalloc_algorithm);
1135            assert_eq!(
1136                parsed_regalloc_algorithm, expected,
1137                "Mismatch for input '{regalloc_value}'. Parsed: {parsed_regalloc_algorithm:?}, Expected: {expected:?}"
1138            );
1139        }
1140
1141        // Strategy
1142        for (strategy_value, expected) in [
1143            ("\"cranelift\"", Some(wasmtime::Strategy::Cranelift)),
1144            ("\"winch\"", Some(wasmtime::Strategy::Winch)),
1145            ("\"hello\"", None), // should fail
1146            ("5", None),         // should fail
1147            ("true", None),      // should fail
1148        ] {
1149            let toml = format!(
1150                r#"
1151                    [codegen]
1152                    compiler = {strategy_value}
1153                "#,
1154            );
1155            let parsed_strategy = toml::from_str::<CommonOptions>(&toml)
1156                .ok()
1157                .and_then(|common_options| common_options.codegen.compiler);
1158            assert_eq!(
1159                parsed_strategy, expected,
1160                "Mismatch for input '{strategy_value}'. Parsed: {parsed_strategy:?}, Expected: {expected:?}",
1161            );
1162        }
1163
1164        // Collector
1165        for (collector_value, expected) in [
1166            (
1167                "\"drc\"",
1168                Some(wasmtime::Collector::DeferredReferenceCounting),
1169            ),
1170            ("\"null\"", Some(wasmtime::Collector::Null)),
1171            ("\"hello\"", None), // should fail
1172            ("5", None),         // should fail
1173            ("true", None),      // should fail
1174        ] {
1175            let toml = format!(
1176                r#"
1177                    [codegen]
1178                    collector = {collector_value}
1179                "#,
1180            );
1181            let parsed_collector = toml::from_str::<CommonOptions>(&toml)
1182                .ok()
1183                .and_then(|common_options| common_options.codegen.collector);
1184            assert_eq!(
1185                parsed_collector, expected,
1186                "Mismatch for input '{collector_value}'. Parsed: {parsed_collector:?}, Expected: {expected:?}",
1187            );
1188        }
1189    }
1190}
1191
1192impl Default for CommonOptions {
1193    fn default() -> CommonOptions {
1194        CommonOptions::new()
1195    }
1196}
1197
1198impl fmt::Display for CommonOptions {
1199    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1200        let CommonOptions {
1201            codegen_raw,
1202            codegen,
1203            debug_raw,
1204            debug,
1205            opts_raw,
1206            opts,
1207            wasm_raw,
1208            wasm,
1209            wasi_raw,
1210            wasi,
1211            configured,
1212            target,
1213            config,
1214        } = self;
1215        if let Some(target) = target {
1216            write!(f, "--target {target} ")?;
1217        }
1218        if let Some(config) = config {
1219            write!(f, "--config {} ", config.display())?;
1220        }
1221
1222        let codegen_flags;
1223        let opts_flags;
1224        let wasi_flags;
1225        let wasm_flags;
1226        let debug_flags;
1227
1228        if *configured {
1229            codegen_flags = codegen.to_options();
1230            debug_flags = debug.to_options();
1231            wasi_flags = wasi.to_options();
1232            wasm_flags = wasm.to_options();
1233            opts_flags = opts.to_options();
1234        } else {
1235            codegen_flags = codegen_raw
1236                .iter()
1237                .flat_map(|t| t.0.iter())
1238                .cloned()
1239                .collect();
1240            debug_flags = debug_raw.iter().flat_map(|t| t.0.iter()).cloned().collect();
1241            wasi_flags = wasi_raw.iter().flat_map(|t| t.0.iter()).cloned().collect();
1242            wasm_flags = wasm_raw.iter().flat_map(|t| t.0.iter()).cloned().collect();
1243            opts_flags = opts_raw.iter().flat_map(|t| t.0.iter()).cloned().collect();
1244        }
1245
1246        for flag in codegen_flags {
1247            write!(f, "-C{flag} ")?;
1248        }
1249        for flag in opts_flags {
1250            write!(f, "-O{flag} ")?;
1251        }
1252        for flag in wasi_flags {
1253            write!(f, "-S{flag} ")?;
1254        }
1255        for flag in wasm_flags {
1256            write!(f, "-W{flag} ")?;
1257        }
1258        for flag in debug_flags {
1259            write!(f, "-D{flag} ")?;
1260        }
1261
1262        Ok(())
1263    }
1264}
wasmtime_cli_flags/lib.rs

wasmtime_cli_flags/
lib.rs
