wasmtime / PR #9811 Create wasmtime::Config from toml · git-wasmtime

Stream: git-wasmtime

Topic: wasmtime / PR #9811 Create wasmtime::Config from toml

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:16):

ludfjig opened PR #9811 from ludfjig:ludfjig/fileconfig to bytecodealliance:main:

This PR makes it possible to create a wasmtime::Config from a toml file and is a first step toward resolving #8784. Overall, I think the path forward is as follows:

This PR: Enables loading wasmtime::Config from a toml file, by making CommonOptions derive Deserialize. For example, opt_level is deserialized from values 0, 1, 2, "s" (same as cli flags) instead of "None", "Speed", "SpeedAndSize". Same applies to regalloc_algorithm, compiler and collector.

Combine cache-config toml with this new toml.

Have one source of truth for cli flags and config options.

Feedback greatly appreciated.

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:16):

ludfjig requested wasmtime-core-reviewers for a review on PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:16):

ludfjig requested alexcrichton for a review on PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:17):

ludfjig edited PR #9811:

This PR makes it possible to create a wasmtime::Config from a toml file and is a first step toward resolving #8784. Overall, I think the path forward is as follows:

This PR: Enables loading wasmtime::Config from a toml file, by making CommonOptions derive Deserialize. For example, opt_level is deserialized from values 0, 1, 2, "s" (same as cli flags) instead of "None", "Speed", "SpeedAndSize". Same applies to regalloc_algorithm, compiler and collector.

Combine cache-config toml with this new toml.

Have one source of truth for cli flags and config options.

Feedback greatly appreciated, especially regarding how to deal with WasiNnGraph, as well config_var and keyvalue_in_memory_data, which are all marked serde(skip) for now

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:18):

ludfjig edited PR #9811:

This PR makes it possible to create a wasmtime::Config from a toml file and is a first step toward resolving #8784. Overall, I think the path forward is as follows:

This PR: Enables loading wasmtime::Config from a toml file, by making CommonOptions derive Deserialize. For example, opt_level is deserialized from values 0, 1, 2, "s" (same as cli flags) instead of "None", "Speed", "SpeedAndSize". Same applies to regalloc_algorithm, compiler and collector.

Combine cache-config toml with this new toml.

Have one source of truth for cli flags and config options.

Feedback greatly appreciated, especially regarding how to deal with nn_graph, as well config_var and keyvalue_in_memory_data, which are all marked serde(skip) for now

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:20):

ludfjig updated PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:22):

ludfjig updated PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:39):

ludfjig updated PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 00:40):

ludfjig edited PR #9811:

This PR makes it possible to create a wasmtime::Config from a toml file and is a first step toward resolving #8784. Overall, I think the path forward is as follows:

This PR: Enables loading wasmtime::Config from a toml file, by making CommonOptions derive Deserialize. For example, opt_level is deserialized from values 0, 1, 2, "s" (same as cli flags) instead of "None", "Speed", "SpeedAndSize". Same applies to regalloc_algorithm, compiler and collector. Feedback appreciated on this.

Combine cache-config toml with this new toml.

Have one source of truth for cli flags and config options.

Feedback greatly appreciated, especially regarding how to deal with nn_graph, as well config_var and keyvalue_in_memory_data, which are all marked serde(skip) for now

Wasmtime GitHub notifications bot (Dec 13 2024 at 02:17):

github-actions[bot] commented on PR #9811:

Label Messager: wasmtime:config

It looks like you are changing Wasmtime's configuration options. Make sure to
complete this check list:

[ ] If you added a new Config method, you wrote extensive documentation for
it.

<details>

Our documentation should be of the following form:

```text
Short, simple summary sentence.

More details. These details can be multiple paragraphs. There should be
information about not just the method, but its parameters and results as
well.

Is this method fallible? If so, when can it return an error?

Can this method panic? If so, when does it panic?

Example

Optional example here.
```

</details>

[ ] If you added a new Config method, or modified an existing one, you
ensured that this configuration is exercised by the fuzz targets.

<details>

For example, if you expose a new strategy for allocating the next instance
slot inside the pooling allocator, you should ensure that at least one of our
fuzz targets exercises that new strategy.

Often, all that is required of you is to ensure that there is a knob for this
configuration option in [wasmtime_fuzzing::Config][fuzzing-config] (or one
of its nested structs).

Rarely, this may require authoring a new fuzz target to specifically test this
configuration. See [our docs on fuzzing][fuzzing-docs] for more details.

</details>

[ ] If you are enabling a configuration option by default, make sure that it
has been fuzzed for at least two weeks before turning it on by default.

[fuzzing-config]: https://github.com/bytecodealliance/wasmtime/blob/ca0e8d0a1d8cefc0496dba2f77a670571d8fdcab/crates/fuzzing/src/generators.rs#L182-L194
[fuzzing-docs]: https://docs.wasmtime.dev/contributing-fuzzing.html

<details>

To modify this label's message, edit the <code>.github/label-messager/wasmtime-config.md</code> file.

To add new label messages or remove existing label messages, edit the
<code>.github/label-messager.json</code> configuration file.

Learn more.

</details>

Wasmtime GitHub notifications bot (Dec 13 2024 at 17:04):

alexcrichton submitted PR review:

Thanks for this! I'm liking how this is shaping up pretty cleanly so far. Would you be up for integrating this into a CLI flag itself as well? For example wasmtime --config cfg.toml or something like that

Wasmtime GitHub notifications bot (Dec 13 2024 at 17:04):

alexcrichton created PR review comment:

Mind updating the error using .with_context(...) to attach the name of the file here and below?

Wasmtime GitHub notifications bot (Dec 13 2024 at 17:04):

alexcrichton created PR review comment:

This might perhaps be best as an inherent method on CommonOptions as an alternative constructor? That would still require the caller call .config(...) but that seems like a reasonable tradeoff to me.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:02):

ludfjig updated PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:04):

ludfjig submitted PR review.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:04):

ludfjig created PR review comment:

I agree

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:05):

ludfjig submitted PR review.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:05):

ludfjig created PR review comment:

addressed.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:09):

ludfjig commented on PR #9811:

Thanks for this! I'm liking how this is shaping up pretty cleanly so far. Would you be up for integrating this into a CLI flag itself as well? For example wasmtime --config cfg.toml or something like that

Thanks for looking at this. I added a --config flag. Any suggestions on how to best test this?

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:11):

ludfjig updated PR #9811.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:12):

ludfjig edited PR review comment.

Wasmtime GitHub notifications bot (Dec 13 2024 at 23:12):

ludfjig edited PR review comment.

Wasmtime GitHub notifications bot (Dec 16 2024 at 15:49):

alexcrichton commented on PR #9811:

For tests I'd recommend tests/all/cli_tests.rs or somewhere around there for making a tempdir with a config file

Last updated: Dec 23 2024 at 12:05 UTC