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