1 //! Contains the common Wasmtime command line interface (CLI) flags. 2 3 use anyhow::{Context, Result}; 4 use clap::Parser; 5 use serde::Deserialize; 6 use std::{ 7 fmt, fs, 8 path::{Path, PathBuf}, 9 time::Duration, 10 }; 11 use wasmtime::Config; 12 13 pub mod opt; 14 15 #[cfg(feature = "logging")] 16 fn 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 44 wasmtime_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 203 wasmtime_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 252 wasmtime_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 273 wasmtime_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 /// Configure support for the function-references proposal. 379 pub function_references: Option<bool>, 380 /// Configure support for the stack-switching proposal. 381 pub stack_switching: Option<bool>, 382 /// Configure support for the GC proposal. 383 pub gc: Option<bool>, 384 /// Configure support for the custom-page-sizes proposal. 385 pub custom_page_sizes: Option<bool>, 386 /// Configure support for the wide-arithmetic proposal. 387 pub wide_arithmetic: Option<bool>, 388 /// Configure support for the extended-const proposal. 389 pub extended_const: Option<bool>, 390 /// Configure support for the exceptions proposal. 391 pub exceptions: Option<bool>, 392 /// DEPRECATED: Configure support for the legacy exceptions proposal. 393 pub legacy_exceptions: Option<bool>, 394 } 395 396 enum Wasm { 397 ... 398 } 399 } 400 401 wasmtime_option_group! { 402 #[derive(PartialEq, Clone, Deserialize)] 403 #[serde(rename_all = "kebab-case", deny_unknown_fields)] 404 pub struct WasiOptions { 405 /// Enable support for WASI CLI APIs, including filesystems, sockets, clocks, and random. 406 pub cli: Option<bool>, 407 /// Enable WASI APIs marked as: @unstable(feature = cli-exit-with-code) 408 pub cli_exit_with_code: Option<bool>, 409 /// Deprecated alias for `cli` 410 pub common: Option<bool>, 411 /// Enable support for WASI neural network imports (experimental) 412 pub nn: Option<bool>, 413 /// Enable support for WASI threading imports (experimental). Implies preview2=false. 414 pub threads: Option<bool>, 415 /// Enable support for WASI HTTP imports 416 pub http: Option<bool>, 417 /// Number of distinct write calls to the outgoing body's output-stream 418 /// that the implementation will buffer. 419 /// Default: 1. 420 pub http_outgoing_body_buffer_chunks: Option<usize>, 421 /// Maximum size allowed in a write call to the outgoing body's output-stream. 422 /// Default: 1024 * 1024. 423 pub http_outgoing_body_chunk_size: Option<usize>, 424 /// Enable support for WASI config imports (experimental) 425 pub config: Option<bool>, 426 /// Enable support for WASI key-value imports (experimental) 427 pub keyvalue: Option<bool>, 428 /// Inherit environment variables and file descriptors following the 429 /// systemd listen fd specification (UNIX only) (legacy wasip1 430 /// implementation only) 431 pub listenfd: Option<bool>, 432 /// Grant access to the given TCP listen socket (experimental, legacy 433 /// wasip1 implementation only) 434 #[serde(default)] 435 pub tcplisten: Vec<String>, 436 /// Enable support for WASI TLS (Transport Layer Security) imports (experimental) 437 pub tls: Option<bool>, 438 /// Implement WASI Preview1 using new Preview2 implementation (true, default) or legacy 439 /// implementation (false) 440 pub preview2: Option<bool>, 441 /// Pre-load machine learning graphs (i.e., models) for use by wasi-nn. 442 /// 443 /// Each use of the flag will preload a ML model from the host directory 444 /// using the given model encoding. The model will be mapped to the 445 /// directory name: e.g., `--wasi-nn-graph openvino:/foo/bar` will preload 446 /// an OpenVINO model named `bar`. Note that which model encodings are 447 /// available is dependent on the backends implemented in the 448 /// `wasmtime_wasi_nn` crate. 449 #[serde(skip)] 450 pub nn_graph: Vec<WasiNnGraph>, 451 /// Flag for WASI preview2 to inherit the host's network within the 452 /// guest so it has full access to all addresses/ports/etc. 453 pub inherit_network: Option<bool>, 454 /// Indicates whether `wasi:sockets/ip-name-lookup` is enabled or not. 455 pub allow_ip_name_lookup: Option<bool>, 456 /// Indicates whether `wasi:sockets` TCP support is enabled or not. 457 pub tcp: Option<bool>, 458 /// Indicates whether `wasi:sockets` UDP support is enabled or not. 459 pub udp: Option<bool>, 460 /// Enable WASI APIs marked as: @unstable(feature = network-error-code) 461 pub network_error_code: Option<bool>, 462 /// Allows imports from the `wasi_unstable` core wasm module. 463 pub preview0: Option<bool>, 464 /// Inherit all environment variables from the parent process. 465 /// 466 /// This option can be further overwritten with `--env` flags. 467 pub inherit_env: Option<bool>, 468 /// Pass a wasi config variable to the program. 469 #[serde(skip)] 470 pub config_var: Vec<KeyValuePair>, 471 /// Preset data for the In-Memory provider of WASI key-value API. 472 #[serde(skip)] 473 pub keyvalue_in_memory_data: Vec<KeyValuePair>, 474 } 475 476 enum Wasi { 477 ... 478 } 479 } 480 481 #[derive(Debug, Clone, PartialEq)] 482 pub struct WasiNnGraph { 483 pub format: String, 484 pub dir: String, 485 } 486 487 #[derive(Debug, Clone, PartialEq)] 488 pub struct KeyValuePair { 489 pub key: String, 490 pub value: String, 491 } 492 493 /// Common options for commands that translate WebAssembly modules 494 #[derive(Parser, Clone, Deserialize)] 495 #[serde(deny_unknown_fields)] 496 pub struct CommonOptions { 497 // These options groups are used to parse `-O` and such options but aren't 498 // the raw form consumed by the CLI. Instead they're pushed into the `pub` 499 // fields below as part of the `configure` method. 500 // 501 // Ideally clap would support `pub opts: OptimizeOptions` and parse directly 502 // into that but it does not appear to do so for multiple `-O` flags for 503 // now. 504 /// Optimization and tuning related options for wasm performance, `-O help` to 505 /// see all. 506 #[arg(short = 'O', long = "optimize", value_name = "KEY[=VAL[,..]]")] 507 #[serde(skip)] 508 opts_raw: Vec<opt::CommaSeparated<Optimize>>, 509 510 /// Codegen-related configuration options, `-C help` to see all. 511 #[arg(short = 'C', long = "codegen", value_name = "KEY[=VAL[,..]]")] 512 #[serde(skip)] 513 codegen_raw: Vec<opt::CommaSeparated<Codegen>>, 514 515 /// Debug-related configuration options, `-D help` to see all. 516 #[arg(short = 'D', long = "debug", value_name = "KEY[=VAL[,..]]")] 517 #[serde(skip)] 518 debug_raw: Vec<opt::CommaSeparated<Debug>>, 519 520 /// Options for configuring semantic execution of WebAssembly, `-W help` to see 521 /// all. 522 #[arg(short = 'W', long = "wasm", value_name = "KEY[=VAL[,..]]")] 523 #[serde(skip)] 524 wasm_raw: Vec<opt::CommaSeparated<Wasm>>, 525 526 /// Options for configuring WASI and its proposals, `-S help` to see all. 527 #[arg(short = 'S', long = "wasi", value_name = "KEY[=VAL[,..]]")] 528 #[serde(skip)] 529 wasi_raw: Vec<opt::CommaSeparated<Wasi>>, 530 531 // These fields are filled in by the `configure` method below via the 532 // options parsed from the CLI above. This is what the CLI should use. 533 #[arg(skip)] 534 #[serde(skip)] 535 configured: bool, 536 537 #[arg(skip)] 538 #[serde(rename = "optimize", default)] 539 pub opts: OptimizeOptions, 540 541 #[arg(skip)] 542 #[serde(rename = "codegen", default)] 543 pub codegen: CodegenOptions, 544 545 #[arg(skip)] 546 #[serde(rename = "debug", default)] 547 pub debug: DebugOptions, 548 549 #[arg(skip)] 550 #[serde(rename = "wasm", default)] 551 pub wasm: WasmOptions, 552 553 #[arg(skip)] 554 #[serde(rename = "wasi", default)] 555 pub wasi: WasiOptions, 556 557 /// The target triple; default is the host triple 558 #[arg(long, value_name = "TARGET")] 559 #[serde(skip)] 560 pub target: Option<String>, 561 562 /// Use the specified TOML configuration file. 563 /// This TOML configuration file can provide same configuration options as the 564 /// `--optimize`, `--codgen`, `--debug`, `--wasm`, `--wasi` CLI options, with a couple exceptions. 565 /// 566 /// Additional options specified on the command line will take precedent over options loaded from 567 /// this TOML file. 568 #[arg(long = "config", value_name = "FILE")] 569 #[serde(skip)] 570 pub config: Option<PathBuf>, 571 } 572 573 macro_rules! match_feature { 574 ( 575 [$feat:tt : $config:expr] 576 $val:ident => $e:expr, 577 $p:pat => err, 578 ) => { 579 #[cfg(feature = $feat)] 580 { 581 if let Some($val) = $config { 582 $e; 583 } 584 } 585 #[cfg(not(feature = $feat))] 586 { 587 if let Some($p) = $config { 588 anyhow::bail!(concat!("support for ", $feat, " disabled at compile time")); 589 } 590 } 591 }; 592 } 593 594 impl CommonOptions { 595 /// Creates a blank new set of [`CommonOptions`] that can be configured. 596 pub fn new() -> CommonOptions { 597 CommonOptions { 598 opts_raw: Vec::new(), 599 codegen_raw: Vec::new(), 600 debug_raw: Vec::new(), 601 wasm_raw: Vec::new(), 602 wasi_raw: Vec::new(), 603 configured: true, 604 opts: Default::default(), 605 codegen: Default::default(), 606 debug: Default::default(), 607 wasm: Default::default(), 608 wasi: Default::default(), 609 target: None, 610 config: None, 611 } 612 } 613 614 fn configure(&mut self) -> Result<()> { 615 if self.configured { 616 return Ok(()); 617 } 618 self.configured = true; 619 if let Some(toml_config_path) = &self.config { 620 let toml_options = CommonOptions::from_file(toml_config_path)?; 621 self.opts = toml_options.opts; 622 self.codegen = toml_options.codegen; 623 self.debug = toml_options.debug; 624 self.wasm = toml_options.wasm; 625 self.wasi = toml_options.wasi; 626 } 627 self.opts.configure_with(&self.opts_raw); 628 self.codegen.configure_with(&self.codegen_raw); 629 self.debug.configure_with(&self.debug_raw); 630 self.wasm.configure_with(&self.wasm_raw); 631 self.wasi.configure_with(&self.wasi_raw); 632 Ok(()) 633 } 634 635 pub fn init_logging(&mut self) -> Result<()> { 636 self.configure()?; 637 if self.debug.logging == Some(false) { 638 return Ok(()); 639 } 640 #[cfg(feature = "logging")] 641 if self.debug.log_to_files == Some(true) { 642 let prefix = "wasmtime.dbg."; 643 init_file_per_thread_logger(prefix); 644 } else { 645 use std::io::IsTerminal; 646 use tracing_subscriber::{EnvFilter, FmtSubscriber}; 647 let builder = FmtSubscriber::builder() 648 .with_writer(std::io::stderr) 649 .with_env_filter(EnvFilter::from_env("WASMTIME_LOG")) 650 .with_ansi(std::io::stderr().is_terminal()); 651 if std::env::var("WASMTIME_LOG_NO_CONTEXT").is_ok_and(|value| value.eq("1")) { 652 builder 653 .with_level(false) 654 .with_target(false) 655 .without_time() 656 .init() 657 } else { 658 builder.init(); 659 } 660 } 661 #[cfg(not(feature = "logging"))] 662 if self.debug.log_to_files == Some(true) || self.debug.logging == Some(true) { 663 anyhow::bail!("support for logging disabled at compile time"); 664 } 665 Ok(()) 666 } 667 668 pub fn config(&mut self, pooling_allocator_default: Option<bool>) -> Result<Config> { 669 self.configure()?; 670 let mut config = Config::new(); 671 672 match_feature! { 673 ["cranelift" : self.codegen.compiler] 674 strategy => config.strategy(strategy), 675 _ => err, 676 } 677 match_feature! { 678 ["gc" : self.codegen.collector] 679 collector => config.collector(collector), 680 _ => err, 681 } 682 if let Some(target) = &self.target { 683 config.target(target)?; 684 } 685 match_feature! { 686 ["cranelift" : self.codegen.cranelift_debug_verifier] 687 enable => config.cranelift_debug_verifier(enable), 688 true => err, 689 } 690 if let Some(enable) = self.debug.debug_info { 691 config.debug_info(enable); 692 } 693 if self.debug.coredump.is_some() { 694 #[cfg(feature = "coredump")] 695 config.coredump_on_trap(true); 696 #[cfg(not(feature = "coredump"))] 697 anyhow::bail!("support for coredumps disabled at compile time"); 698 } 699 match_feature! { 700 ["cranelift" : self.opts.opt_level] 701 level => config.cranelift_opt_level(level), 702 _ => err, 703 } 704 match_feature! { 705 ["cranelift": self.opts.regalloc_algorithm] 706 algo => config.cranelift_regalloc_algorithm(algo), 707 _ => err, 708 } 709 match_feature! { 710 ["cranelift" : self.wasm.nan_canonicalization] 711 enable => config.cranelift_nan_canonicalization(enable), 712 true => err, 713 } 714 match_feature! { 715 ["cranelift" : self.codegen.pcc] 716 enable => config.cranelift_pcc(enable), 717 true => err, 718 } 719 720 self.enable_wasm_features(&mut config)?; 721 722 #[cfg(feature = "cranelift")] 723 for (name, value) in self.codegen.cranelift.iter() { 724 let name = name.replace('-', "_"); 725 unsafe { 726 match value { 727 Some(val) => { 728 config.cranelift_flag_set(&name, val); 729 } 730 None => { 731 config.cranelift_flag_enable(&name); 732 } 733 } 734 } 735 } 736 #[cfg(not(feature = "cranelift"))] 737 if !self.codegen.cranelift.is_empty() { 738 anyhow::bail!("support for cranelift disabled at compile time"); 739 } 740 741 #[cfg(feature = "cache")] 742 if self.codegen.cache != Some(false) { 743 use wasmtime::Cache; 744 let cache = match &self.codegen.cache_config { 745 Some(path) => Cache::from_file(Some(Path::new(path)))?, 746 None => Cache::from_file(None)?, 747 }; 748 config.cache(Some(cache)); 749 } 750 #[cfg(not(feature = "cache"))] 751 if self.codegen.cache == Some(true) { 752 anyhow::bail!("support for caching disabled at compile time"); 753 } 754 755 match_feature! { 756 ["parallel-compilation" : self.codegen.parallel_compilation] 757 enable => config.parallel_compilation(enable), 758 true => err, 759 } 760 761 let memory_reservation = self 762 .opts 763 .memory_reservation 764 .or(self.opts.static_memory_maximum_size); 765 if let Some(size) = memory_reservation { 766 config.memory_reservation(size); 767 } 768 769 if let Some(enable) = self.opts.static_memory_forced { 770 config.memory_may_move(!enable); 771 } 772 if let Some(enable) = self.opts.memory_may_move { 773 config.memory_may_move(enable); 774 } 775 776 let memory_guard_size = self 777 .opts 778 .static_memory_guard_size 779 .or(self.opts.dynamic_memory_guard_size) 780 .or(self.opts.memory_guard_size); 781 if let Some(size) = memory_guard_size { 782 config.memory_guard_size(size); 783 } 784 785 let mem_for_growth = self 786 .opts 787 .memory_reservation_for_growth 788 .or(self.opts.dynamic_memory_reserved_for_growth); 789 if let Some(size) = mem_for_growth { 790 config.memory_reservation_for_growth(size); 791 } 792 if let Some(enable) = self.opts.guard_before_linear_memory { 793 config.guard_before_linear_memory(enable); 794 } 795 if let Some(enable) = self.opts.table_lazy_init { 796 config.table_lazy_init(enable); 797 } 798 799 // If fuel has been configured, set the `consume fuel` flag on the config. 800 if self.wasm.fuel.is_some() { 801 config.consume_fuel(true); 802 } 803 804 if let Some(enable) = self.wasm.epoch_interruption { 805 config.epoch_interruption(enable); 806 } 807 if let Some(enable) = self.debug.address_map { 808 config.generate_address_map(enable); 809 } 810 if let Some(enable) = self.opts.memory_init_cow { 811 config.memory_init_cow(enable); 812 } 813 if let Some(size) = self.opts.memory_guaranteed_dense_image_size { 814 config.memory_guaranteed_dense_image_size(size); 815 } 816 if let Some(enable) = self.opts.signals_based_traps { 817 config.signals_based_traps(enable); 818 } 819 if let Some(enable) = self.codegen.native_unwind_info { 820 config.native_unwind_info(enable); 821 } 822 823 // async_stack_size enabled by either async or stack-switching, so 824 // cannot directly use match_feature! 825 #[cfg(any(feature = "async", feature = "stack-switching"))] 826 { 827 if let Some(size) = self.wasm.async_stack_size { 828 config.async_stack_size(size); 829 } 830 } 831 #[cfg(not(any(feature = "async", feature = "stack-switching")))] 832 { 833 if let Some(_size) = self.wasm.async_stack_size { 834 anyhow::bail!(concat!( 835 "support for async/stack-switching disabled at compile time" 836 )); 837 } 838 } 839 840 match_feature! { 841 ["pooling-allocator" : self.opts.pooling_allocator.or(pooling_allocator_default)] 842 enable => { 843 if enable { 844 let mut cfg = wasmtime::PoolingAllocationConfig::default(); 845 if let Some(size) = self.opts.pooling_memory_keep_resident { 846 cfg.linear_memory_keep_resident(size); 847 } 848 if let Some(size) = self.opts.pooling_table_keep_resident { 849 cfg.table_keep_resident(size); 850 } 851 if let Some(limit) = self.opts.pooling_total_core_instances { 852 cfg.total_core_instances(limit); 853 } 854 if let Some(limit) = self.opts.pooling_total_component_instances { 855 cfg.total_component_instances(limit); 856 } 857 if let Some(limit) = self.opts.pooling_total_memories { 858 cfg.total_memories(limit); 859 } 860 if let Some(limit) = self.opts.pooling_total_tables { 861 cfg.total_tables(limit); 862 } 863 if let Some(limit) = self.opts.pooling_table_elements 864 .or(self.wasm.max_table_elements) 865 { 866 cfg.table_elements(limit); 867 } 868 if let Some(limit) = self.opts.pooling_max_core_instance_size { 869 cfg.max_core_instance_size(limit); 870 } 871 match_feature! { 872 ["async" : self.opts.pooling_total_stacks] 873 limit => cfg.total_stacks(limit), 874 _ => err, 875 } 876 if let Some(max) = self.opts.pooling_max_memory_size 877 .or(self.wasm.max_memory_size) 878 { 879 cfg.max_memory_size(max); 880 } 881 if let Some(size) = self.opts.pooling_decommit_batch_size { 882 cfg.decommit_batch_size(size); 883 } 884 if let Some(max) = self.opts.pooling_max_unused_warm_slots { 885 cfg.max_unused_warm_slots(max); 886 } 887 match_feature! { 888 ["async" : self.opts.pooling_async_stack_keep_resident] 889 size => cfg.async_stack_keep_resident(size), 890 _ => err, 891 } 892 if let Some(max) = self.opts.pooling_max_component_instance_size { 893 cfg.max_component_instance_size(max); 894 } 895 if let Some(max) = self.opts.pooling_max_core_instances_per_component { 896 cfg.max_core_instances_per_component(max); 897 } 898 if let Some(max) = self.opts.pooling_max_memories_per_component { 899 cfg.max_memories_per_component(max); 900 } 901 if let Some(max) = self.opts.pooling_max_tables_per_component { 902 cfg.max_tables_per_component(max); 903 } 904 if let Some(max) = self.opts.pooling_max_tables_per_module { 905 cfg.max_tables_per_module(max); 906 } 907 if let Some(max) = self.opts.pooling_max_memories_per_module { 908 cfg.max_memories_per_module(max); 909 } 910 match_feature! { 911 ["memory-protection-keys" : self.opts.pooling_memory_protection_keys] 912 enable => cfg.memory_protection_keys(enable), 913 _ => err, 914 } 915 match_feature! { 916 ["memory-protection-keys" : self.opts.pooling_max_memory_protection_keys] 917 max => cfg.max_memory_protection_keys(max), 918 _ => err, 919 } 920 match_feature! { 921 ["gc" : self.opts.pooling_total_gc_heaps] 922 max => cfg.total_gc_heaps(max), 923 _ => err, 924 } 925 config.allocation_strategy(wasmtime::InstanceAllocationStrategy::Pooling(cfg)); 926 } 927 }, 928 true => err, 929 } 930 931 if self.opts.pooling_memory_protection_keys.is_some() 932 && !self.opts.pooling_allocator.unwrap_or(false) 933 { 934 anyhow::bail!("memory protection keys require the pooling allocator"); 935 } 936 937 if self.opts.pooling_max_memory_protection_keys.is_some() 938 && !self.opts.pooling_memory_protection_keys.is_some() 939 { 940 anyhow::bail!( 941 "max memory protection keys requires memory protection keys to be enabled" 942 ); 943 } 944 945 match_feature! { 946 ["async" : self.wasm.async_stack_zeroing] 947 enable => config.async_stack_zeroing(enable), 948 _ => err, 949 } 950 951 if let Some(max) = self.wasm.max_wasm_stack { 952 config.max_wasm_stack(max); 953 954 // If `-Wasync-stack-size` isn't passed then automatically adjust it 955 // to the wasm stack size provided here too. That prevents the need 956 // to pass both when one can generally be inferred from the other. 957 #[cfg(any(feature = "async", feature = "stack-switching"))] 958 if self.wasm.async_stack_size.is_none() { 959 const DEFAULT_HOST_STACK: usize = 512 << 10; 960 config.async_stack_size(max + DEFAULT_HOST_STACK); 961 } 962 } 963 964 if let Some(enable) = self.wasm.relaxed_simd_deterministic { 965 config.relaxed_simd_deterministic(enable); 966 } 967 match_feature! { 968 ["cranelift" : self.wasm.wmemcheck] 969 enable => config.wmemcheck(enable), 970 true => err, 971 } 972 973 Ok(config) 974 } 975 976 pub fn enable_wasm_features(&self, config: &mut Config) -> Result<()> { 977 let all = self.wasm.all_proposals; 978 979 if let Some(enable) = self.wasm.simd.or(all) { 980 config.wasm_simd(enable); 981 } 982 if let Some(enable) = self.wasm.relaxed_simd.or(all) { 983 config.wasm_relaxed_simd(enable); 984 } 985 if let Some(enable) = self.wasm.bulk_memory.or(all) { 986 config.wasm_bulk_memory(enable); 987 } 988 if let Some(enable) = self.wasm.multi_value.or(all) { 989 config.wasm_multi_value(enable); 990 } 991 if let Some(enable) = self.wasm.tail_call.or(all) { 992 config.wasm_tail_call(enable); 993 } 994 if let Some(enable) = self.wasm.multi_memory.or(all) { 995 config.wasm_multi_memory(enable); 996 } 997 if let Some(enable) = self.wasm.memory64.or(all) { 998 config.wasm_memory64(enable); 999 } 1000 if let Some(enable) = self.wasm.stack_switching { 1001 config.wasm_stack_switching(enable); 1002 } 1003 if let Some(enable) = self.wasm.custom_page_sizes.or(all) { 1004 config.wasm_custom_page_sizes(enable); 1005 } 1006 if let Some(enable) = self.wasm.wide_arithmetic.or(all) { 1007 config.wasm_wide_arithmetic(enable); 1008 } 1009 if let Some(enable) = self.wasm.extended_const.or(all) { 1010 config.wasm_extended_const(enable); 1011 } 1012 if let Some(enable) = self.wasm.exceptions.or(all) { 1013 config.wasm_exceptions(enable); 1014 } 1015 if let Some(enable) = self.wasm.legacy_exceptions.or(all) { 1016 #[expect(deprecated, reason = "forwarding CLI flag")] 1017 config.wasm_legacy_exceptions(enable); 1018 } 1019 1020 macro_rules! handle_conditionally_compiled { 1021 ($(($feature:tt, $field:tt, $method:tt))*) => ($( 1022 if let Some(enable) = self.wasm.$field.or(all) { 1023 #[cfg(feature = $feature)] 1024 config.$method(enable); 1025 #[cfg(not(feature = $feature))] 1026 if enable && all.is_none() { 1027 anyhow::bail!("support for {} was disabled at compile-time", $feature); 1028 } 1029 } 1030 )*) 1031 } 1032 1033 handle_conditionally_compiled! { 1034 ("component-model", component_model, wasm_component_model) 1035 ("component-model-async", component_model_async, wasm_component_model_async) 1036 ("component-model-async", component_model_async_builtins, wasm_component_model_async_builtins) 1037 ("component-model-async", component_model_async_stackful, wasm_component_model_async_stackful) 1038 ("component-model", component_model_error_context, wasm_component_model_error_context) 1039 ("threads", threads, wasm_threads) 1040 ("gc", gc, wasm_gc) 1041 ("gc", reference_types, wasm_reference_types) 1042 ("gc", function_references, wasm_function_references) 1043 ("stack-switching", stack_switching, wasm_stack_switching) 1044 } 1045 Ok(()) 1046 } 1047 1048 pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> { 1049 let path_ref = path.as_ref(); 1050 let file_contents = fs::read_to_string(path_ref) 1051 .with_context(|| format!("failed to read config file: {path_ref:?}"))?; 1052 toml::from_str::<CommonOptions>(&file_contents) 1053 .with_context(|| format!("failed to parse TOML config file {path_ref:?}")) 1054 } 1055 } 1056 1057 #[cfg(test)] 1058 mod tests { 1059 use wasmtime::{OptLevel, RegallocAlgorithm}; 1060 1061 use super::*; 1062 1063 #[test] 1064 fn from_toml() { 1065 // empty toml 1066 let empty_toml = ""; 1067 let mut common_options: CommonOptions = toml::from_str(empty_toml).unwrap(); 1068 common_options.config(None).unwrap(); 1069 1070 // basic toml 1071 let basic_toml = r#" 1072 [optimize] 1073 [codegen] 1074 [debug] 1075 [wasm] 1076 [wasi] 1077 "#; 1078 let mut common_options: CommonOptions = toml::from_str(basic_toml).unwrap(); 1079 common_options.config(None).unwrap(); 1080 1081 // toml with custom deserialization to match CLI flag parsing 1082 for (opt_value, expected) in [ 1083 ("0", Some(OptLevel::None)), 1084 ("1", Some(OptLevel::Speed)), 1085 ("2", Some(OptLevel::Speed)), 1086 ("\"s\"", Some(OptLevel::SpeedAndSize)), 1087 ("\"hello\"", None), // should fail 1088 ("3", None), // should fail 1089 ] { 1090 let toml = format!( 1091 r#" 1092 [optimize] 1093 opt-level = {opt_value} 1094 "#, 1095 ); 1096 let parsed_opt_level = toml::from_str::<CommonOptions>(&toml) 1097 .ok() 1098 .and_then(|common_options| common_options.opts.opt_level); 1099 1100 assert_eq!( 1101 parsed_opt_level, expected, 1102 "Mismatch for input '{opt_value}'. Parsed: {parsed_opt_level:?}, Expected: {expected:?}" 1103 ); 1104 } 1105 1106 // Regalloc algorithm 1107 for (regalloc_value, expected) in [ 1108 ("\"backtracking\"", Some(RegallocAlgorithm::Backtracking)), 1109 ("\"hello\"", None), // should fail 1110 ("3", None), // should fail 1111 ("true", None), // should fail 1112 ] { 1113 let toml = format!( 1114 r#" 1115 [optimize] 1116 regalloc-algorithm = {regalloc_value} 1117 "#, 1118 ); 1119 let parsed_regalloc_algorithm = toml::from_str::<CommonOptions>(&toml) 1120 .ok() 1121 .and_then(|common_options| common_options.opts.regalloc_algorithm); 1122 assert_eq!( 1123 parsed_regalloc_algorithm, expected, 1124 "Mismatch for input '{regalloc_value}'. Parsed: {parsed_regalloc_algorithm:?}, Expected: {expected:?}" 1125 ); 1126 } 1127 1128 // Strategy 1129 for (strategy_value, expected) in [ 1130 ("\"cranelift\"", Some(wasmtime::Strategy::Cranelift)), 1131 ("\"winch\"", Some(wasmtime::Strategy::Winch)), 1132 ("\"hello\"", None), // should fail 1133 ("5", None), // should fail 1134 ("true", None), // should fail 1135 ] { 1136 let toml = format!( 1137 r#" 1138 [codegen] 1139 compiler = {strategy_value} 1140 "#, 1141 ); 1142 let parsed_strategy = toml::from_str::<CommonOptions>(&toml) 1143 .ok() 1144 .and_then(|common_options| common_options.codegen.compiler); 1145 assert_eq!( 1146 parsed_strategy, expected, 1147 "Mismatch for input '{strategy_value}'. Parsed: {parsed_strategy:?}, Expected: {expected:?}", 1148 ); 1149 } 1150 1151 // Collector 1152 for (collector_value, expected) in [ 1153 ( 1154 "\"drc\"", 1155 Some(wasmtime::Collector::DeferredReferenceCounting), 1156 ), 1157 ("\"null\"", Some(wasmtime::Collector::Null)), 1158 ("\"hello\"", None), // should fail 1159 ("5", None), // should fail 1160 ("true", None), // should fail 1161 ] { 1162 let toml = format!( 1163 r#" 1164 [codegen] 1165 collector = {collector_value} 1166 "#, 1167 ); 1168 let parsed_collector = toml::from_str::<CommonOptions>(&toml) 1169 .ok() 1170 .and_then(|common_options| common_options.codegen.collector); 1171 assert_eq!( 1172 parsed_collector, expected, 1173 "Mismatch for input '{collector_value}'. Parsed: {parsed_collector:?}, Expected: {expected:?}", 1174 ); 1175 } 1176 } 1177 } 1178 1179 impl Default for CommonOptions { 1180 fn default() -> CommonOptions { 1181 CommonOptions::new() 1182 } 1183 } 1184 1185 impl fmt::Display for CommonOptions { 1186 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 1187 let CommonOptions { 1188 codegen_raw, 1189 codegen, 1190 debug_raw, 1191 debug, 1192 opts_raw, 1193 opts, 1194 wasm_raw, 1195 wasm, 1196 wasi_raw, 1197 wasi, 1198 configured, 1199 target, 1200 config, 1201 } = self; 1202 if let Some(target) = target { 1203 write!(f, "--target {target} ")?; 1204 } 1205 if let Some(config) = config { 1206 write!(f, "--config {} ", config.display())?; 1207 } 1208 1209 let codegen_flags; 1210 let opts_flags; 1211 let wasi_flags; 1212 let wasm_flags; 1213 let debug_flags; 1214 1215 if *configured { 1216 codegen_flags = codegen.to_options(); 1217 debug_flags = debug.to_options(); 1218 wasi_flags = wasi.to_options(); 1219 wasm_flags = wasm.to_options(); 1220 opts_flags = opts.to_options(); 1221 } else { 1222 codegen_flags = codegen_raw 1223 .iter() 1224 .flat_map(|t| t.0.iter()) 1225 .cloned() 1226 .collect(); 1227 debug_flags = debug_raw.iter().flat_map(|t| t.0.iter()).cloned().collect(); 1228 wasi_flags = wasi_raw.iter().flat_map(|t| t.0.iter()).cloned().collect(); 1229 wasm_flags = wasm_raw.iter().flat_map(|t| t.0.iter()).cloned().collect(); 1230 opts_flags = opts_raw.iter().flat_map(|t| t.0.iter()).cloned().collect(); 1231 } 1232 1233 for flag in codegen_flags { 1234 write!(f, "-C{flag} ")?; 1235 } 1236 for flag in opts_flags { 1237 write!(f, "-O{flag} ")?; 1238 } 1239 for flag in wasi_flags { 1240 write!(f, "-S{flag} ")?; 1241 } 1242 for flag in wasm_flags { 1243 write!(f, "-W{flag} ")?; 1244 } 1245 for flag in debug_flags { 1246 write!(f, "-D{flag} ")?; 1247 } 1248 1249 Ok(()) 1250 } 1251 } 1252