wasmtime icon indicating copy to clipboard operation
wasmtime copied to clipboard

Support cleanup during unwinding

Open bjorn3 opened this issue 5 years ago • 5 comments

Feature

Currently the generated unwinding information only restores registers. This issue proposes to make it possible to also run cleanup actions like running destructors during unwinding.

Benefit

This is necessary to support unwinding after a panic in rustc_codegen_cranelift.

Implementation

Add a new invoke terminator that is similar to the call instruction, but has an additional cleanup edge. This cleanup edge will be ignored when emitting actual machine instructions, but it will take part in the regalloc. Next add a way to mark a block as "landing pad". Only "landing pad" blocks can be used as cleanup edge of an invoke terminator. At the start of a "cleanup" block all values are stored either on stack or in any of the registers restored by the system unwinder. The "landing pad" block can also take several arguments. Those will be the values stored in the registers that are allowed for arguments to the landing pad received from the personality function. After codegen the location of every "landing pad" block will be stored in a variable. This will allow the embedder to generate the appropriate LSDA (language specific data area) to reference from the unwinding table.

Alternatives

It is basically impossible to implement cleanup during unwinding without Cranelift support.

References

The "Transferring Control to a Landing Pad" section of https://software.intel.com/sites/default/files/article/402129/mpx-linux64-abi.pdf

bjorn3 avatar May 10 '20 19:05 bjorn3

Original pdf no longer exists. See https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html instead.

bjorn3 avatar Jul 03 '21 09:07 bjorn3

Could this issue be solved independently using the aforementioned solution in the OP's comment or would #3427 be needed to be resolved first?

bayedieng avatar Feb 26 '23 11:02 bayedieng

I'm working on this.

bjorn3 avatar Feb 26 '23 11:02 bjorn3

@bjorn3 Any PR or branch where it is possible to follow progress?

noverby avatar Jun 26 '24 10:06 noverby

https://github.com/bjorn3/wasmtime/tree/bsc-unwinding-simple-invoke3 is the latest version I have. I will rebase it and work on upstreaming when I finish my thesis about it.

bjorn3 avatar Jun 26 '24 10:06 bjorn3

Cleaning up old issues and I believe this is covered now by the exceptions support we landed recently (#10510). Thanks all (and thanks bjorn3 for the experimental work that helped us develop our current design).

cfallin avatar Apr 23 '25 23:04 cfallin

Oh, does wasmtime support exceptions now? This is incredibly exciting, is there anything I can read on that?

whitequark avatar Apr 24 '25 10:04 whitequark

This isn't implemented on the Wasmtime side yet.

Edit: https://github.com/bytecodealliance/wasmtime/issues/2049, https://github.com/bytecodealliance/wasmtime/issues/3427 and https://github.com/bytecodealliance/wasmtime/issues/10252 are still open.

bjorn3 avatar Apr 24 '25 12:04 bjorn3

Right, this issue was specifically about Cranelift exceptions, @whitequark -- I will hopefully get time to do the Wasmtime side soon (next few months-ish)...

cfallin avatar Apr 24 '25 15:04 cfallin

And if you'd like to learn more, here is the RFC: https://github.com/bytecodealliance/rfcs/pull/36

fitzgen avatar Apr 24 '25 16:04 fitzgen

Thanks all!

whitequark avatar Apr 24 '25 16:04 whitequark