-
Notifications
You must be signed in to change notification settings - Fork 12.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #117072 - betrusted-io:unwinding-crate-support, r=cuviper
Use `unwinding` crate for unwinding on Xous platform This patch adds support for using [unwinding](https://github.com/nbdd0121/unwinding) on platforms where libunwinding isn't viable. An example of such a platform is `riscv32imac-unknown-xous-elf`. ### Background The Rust project maintains a fork of llvm at [llvm-project](https://github.com/rust-lang/llvm-project/) where it applies patches on top of the llvm project. This mostly seems to be to get unwinding support for the SGX project, and there may be other patches that I'm unaware of. There is a lot of machinery in the build system to support compiling `libunwind` on other platforms, and I needed to add additional patches to llvm in order to add support for Xous. Rather than continuing down this path, it seemed much easier to use a Rust-based library. The `unwinding` crate by `@nbdd0121` fits this description perfectly. ### Future work This could potentially replace the custom patches for `libunwind` on other platforms such as SGX, and could enable unwinding support on many more exotic platforms. ### Anti-goals This is not designed to replace `libunwind` on tier-one platforms or those where unwinding support already exists. There is already a well-established approach for unwinding there. Instead, this aims to enable unwinding on new platforms where C++ code may be difficult to compile.
- Loading branch information
Showing
10 changed files
with
164 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| #![allow(nonstandard_style)] | ||
|
|
||
| use libc::{c_int, c_void}; | ||
|
|
||
| #[repr(C)] | ||
| #[derive(Copy, Clone, PartialEq)] | ||
| pub enum _Unwind_Action { | ||
| _UA_SEARCH_PHASE = 1, | ||
| _UA_CLEANUP_PHASE = 2, | ||
| _UA_HANDLER_FRAME = 4, | ||
| _UA_FORCE_UNWIND = 8, | ||
| _UA_END_OF_STACK = 16, | ||
| } | ||
| pub use _Unwind_Action::*; | ||
|
|
||
| #[repr(C)] | ||
| #[derive(Debug, Copy, Clone, PartialEq)] | ||
| pub enum _Unwind_Reason_Code { | ||
| _URC_NO_REASON = 0, | ||
| _URC_FOREIGN_EXCEPTION_CAUGHT = 1, | ||
| _URC_FATAL_PHASE2_ERROR = 2, | ||
| _URC_FATAL_PHASE1_ERROR = 3, | ||
| _URC_NORMAL_STOP = 4, | ||
| _URC_END_OF_STACK = 5, | ||
| _URC_HANDLER_FOUND = 6, | ||
| _URC_INSTALL_CONTEXT = 7, | ||
| _URC_CONTINUE_UNWIND = 8, | ||
| _URC_FAILURE = 9, // used only by ARM EHABI | ||
| } | ||
| pub use _Unwind_Reason_Code::*; | ||
|
|
||
| pub use unwinding::abi::UnwindContext; | ||
| pub use unwinding::abi::UnwindException; | ||
| pub enum _Unwind_Context {} | ||
|
|
||
| pub use unwinding::custom_eh_frame_finder::{ | ||
| set_custom_eh_frame_finder, EhFrameFinder, FrameInfo, FrameInfoKind, | ||
| }; | ||
|
|
||
| pub type _Unwind_Exception_Class = u64; | ||
| pub type _Unwind_Word = *const u8; | ||
| pub type _Unwind_Ptr = *const u8; | ||
|
|
||
| pub const unwinder_private_data_size: usize = core::mem::size_of::<UnwindException>() | ||
| - core::mem::size_of::<_Unwind_Exception_Class>() | ||
| - core::mem::size_of::<_Unwind_Exception_Cleanup_Fn>(); | ||
|
|
||
| pub type _Unwind_Exception_Cleanup_Fn = | ||
| extern "C" fn(unwind_code: _Unwind_Reason_Code, exception: *mut _Unwind_Exception); | ||
|
|
||
| #[repr(C)] | ||
| pub struct _Unwind_Exception { | ||
| pub exception_class: _Unwind_Exception_Class, | ||
| pub exception_cleanup: _Unwind_Exception_Cleanup_Fn, | ||
| pub private: [_Unwind_Word; unwinder_private_data_size], | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_GetDataRelBase(ctx: *mut _Unwind_Context) -> _Unwind_Ptr { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| unwinding::abi::_Unwind_GetDataRelBase(ctx) as _Unwind_Ptr | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_GetTextRelBase(ctx: *mut _Unwind_Context) -> _Unwind_Ptr { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| unwinding::abi::_Unwind_GetTextRelBase(ctx) as _Unwind_Ptr | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_GetRegionStart(ctx: *mut _Unwind_Context) -> _Unwind_Ptr { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| unwinding::abi::_Unwind_GetRegionStart(ctx) as _Unwind_Ptr | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_SetGR(ctx: *mut _Unwind_Context, reg_index: c_int, value: _Unwind_Word) { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| unwinding::abi::_Unwind_SetGR(ctx, reg_index, value as usize) | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_SetIP(ctx: *mut _Unwind_Context, value: _Unwind_Word) { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| unwinding::abi::_Unwind_SetIP(ctx, value as usize) | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_GetIPInfo( | ||
| ctx: *mut _Unwind_Context, | ||
| ip_before_insn: *mut c_int, | ||
| ) -> _Unwind_Word { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| let ip_before_insn = unsafe { &mut *(ip_before_insn as *mut c_int) }; | ||
| unsafe { &*(unwinding::abi::_Unwind_GetIPInfo(ctx, ip_before_insn) as _Unwind_Word) } | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_GetLanguageSpecificData(ctx: *mut _Unwind_Context) -> *mut c_void { | ||
| let ctx = unsafe { &mut *(ctx as *mut UnwindContext<'_>) }; | ||
| unwinding::abi::_Unwind_GetLanguageSpecificData(ctx) | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_RaiseException(exception: *mut _Unwind_Exception) -> _Unwind_Reason_Code { | ||
| let exception = unsafe { &mut *(exception as *mut UnwindException) }; | ||
| unsafe { core::mem::transmute(unwinding::abi::_Unwind_RaiseException(exception)) } | ||
| } | ||
|
|
||
| pub unsafe fn _Unwind_DeleteException(exception: *mut _Unwind_Exception) { | ||
| let exception = unsafe { &mut *(exception as *mut UnwindException) }; | ||
| unsafe { unwinding::abi::_Unwind_DeleteException(exception) } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters