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