wasmtime / issue #6513 Add core dump support to the runtime · git-wasmtime

Stream: git-wasmtime

Topic: wasmtime / issue #6513 Add core dump support to the runtime

Wasmtime GitHub notifications bot (Jun 02 2023 at 22:44):

github-actions[bot] commented on issue #6513:

Subscribe to Label Action

cc @peterhuene

<details>
This issue or pull request has been labeled: "wasmtime:api", "wasmtime:config"

Thus the following users have been cc'd because of the following labels:

peterhuene: wasmtime:api

To subscribe or unsubscribe from this label, edit the <code>.github/subscribe-to-label.json</code> configuration file.

Learn more.
</details>

Wasmtime GitHub notifications bot (Jun 02 2023 at 22:45):

github-actions[bot] commented on issue #6513:

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 (Jun 29 2023 at 21:32):

itsrainy edited a comment on issue #6513:

Label Messager: wasmtime:config

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

[x] 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 (Jun 29 2023 at 23:22):

itsrainy commented on issue #6513:

@fitzgen I added some smoke tests though I am still trying to figure out why exported Globals and Memories aren't getting included in the CoreDump.

Also in order to downcast the anyhow error to a WasmCoreDump, it needs to #[derive(Debug)]. To make that work I switched the Vec<Module> on the WasmCoreDump to be a vec of just the module names for now. Otherwise it seems like I would have to add #[derive(Debug)] to a whole bunch of things (Module, ModuleInner, Engine, EngineInner, Config, etc) which seemed a bit wide-sweeping.

Wasmtime GitHub notifications bot (Jul 06 2023 at 16:29):

fitzgen commented on issue #6513:

Also in order to downcast the anyhow error to a WasmCoreDump, it needs to #[derive(Debug)]. To make that work I switched the Vec<Module> on the WasmCoreDump to be a vec of just the module names for now. Otherwise it seems like I would have to add #[derive(Debug)] to a whole bunch of things (Module, ModuleInner, Engine, EngineInner, Config, etc) which seemed a bit wide-sweeping.

Ah, I think it would actually be better to make a custom Debug impl for WasmCoreDump than to derive(Debug) in this case. We can start with something like the following, and update it with useful diagnostic information over time as needed.
impl std::fmt::Debug for WasmCoreDump {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "<wasm core dump>")
    }
}
This avoids needing to do derive(Debug) on Module or anything like that and lets us continue to hold onto the modules inside WasmCoreDump.

Last updated: Nov 22 2024 at 16:03 UTC