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