refactors sus_panic and sus_unreachable
#470
Open
Conversation
This file contains hidden or 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 allows us to export it in a module, which means that we don't need to include headers that might expose bugs in Clang's implementation of C++20 modules.
This takes the function out of the global namespace and keeps the function names consistent with others in the project.
Rust's [panic macro] is overloaded to be able to take a message. Now that we've changed the Subspace `sus_panic` macro to a function, we can create an overload set for `panic`. [panic macro]: https://doc.rust-lang.org/stable/std/macro.panic.html
This allows us to export it in a module, which means that we don't need to include headers that might expose bugs in Clang's implementation of C++20 modules.
This takes the function out of the global namespace and keeps the function names consistent with others in the project.
This makes it possible for any call to `sus::panic` to be equivalent to calling the panic handler directly. Users can then have a nice message emitted during debug builds, and an optimised binary in release builds.
danakj
reviewed
May 7, 2025
Co-authored-by: Dana Jansens <danakj@orodu.net>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These macros have been changed to functions, which will provide better ergonomics for C++. Care was taken to ensure that calls to
sus::panicweren't substantially worse than expandingsus_panic. In addition,sus_panic_with_messagewas refactored intosus::panic.The same logic was applied to refactoring
sus_unreachable, although the assembly wasn't inspected.