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