lvella/suyu
1
0
Fork 0
forked from suyu/suyu
Code Pull requests Activity

common: Don't test ASSERT conditions inline

Browse source
This commit is contained in:
Liam 2022-06-07 18:05:32 -04:00
parent 084d7d6b01
commit 58fea44eb5
2 changed files with 36 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/common/assert.cpp
View file

@ -6,9 +6,13 @@
#include "common/settings.h" #include "common/settings.h"
void assert_handle_failure() { void assert_check_condition(bool cond, std::function<void()>&& on_failure) {
if (Settings::values.use_debug_asserts) { if (!cond) {
Crash(); on_failure();
if (Settings::values.use_debug_asserts) {
Crash();
}
} }
} }

58
src/common/assert.h
View file

@ -4,57 +4,57 @@
#pragma once #pragma once
#include <functional>
#include "common/logging/log.h" #include "common/logging/log.h"
// Sometimes we want to try to continue even after hitting an assert. // Sometimes we want to try to continue even after hitting an assert.
// However touching this file yields a global recompilation as this header is included almost // However touching this file yields a global recompilation as this header is included almost
// everywhere. So let's just move the handling of the failed assert to a single cpp file. // everywhere. So let's just move the handling of the failed assert to a single cpp file.
void assert_handle_failure();
[[noreturn]] void unreachable_impl();
// For asserts we'd like to keep all the junk executed when an assert happens away from the // For asserts we'd like to keep all the junk executed when an assert happens away from the
// important code in the function. One way of doing this is to put all the relevant code inside a // important code in the function. One way of doing this is to put all the relevant code inside a
// lambda and force the compiler to not inline it. Unfortunately, MSVC seems to have no syntax to // lambda and force the compiler to not inline it.
// specify __declspec on lambda functions, so what we do instead is define a noinline wrapper void assert_check_condition(bool cond, std::function<void()>&& on_failure);
// template that calls the lambda. This seems to generate an extra instruction at the call-site
// compared to the ideal implementation (which wouldn't support ASSERT_MSG parameters), but is good [[noreturn]] void unreachable_impl();
// enough for our purposes.
template <typename Fn>
#if defined(_MSC_VER)
[[msvc::noinline]]
#elif defined(__GNUC__)
[[gnu::cold, gnu::noinline]]
#endif
static void
assert_noinline_call(const Fn& fn) {
fn();
assert_handle_failure();
}
#define ASSERT(_a_) \ #define ASSERT(_a_) \
do \ do { \
if (!(_a_)) { \ if (std::is_constant_evaluated()) { \
assert_noinline_call([] { LOG_CRITICAL(Debug, "Assertion Failed!"); }); \ if (!(_a_)) { \
/* Will trigger compile error here */ \
assert_check_condition(bool(_a_), \
[] { LOG_CRITICAL(Debug, "Assertion Failed!"); }); \
} \
} else { \
assert_check_condition(bool(_a_), [] { LOG_CRITICAL(Debug, "Assertion Failed!"); }); \
} \ } \
while (0) } while (0)
#define ASSERT_MSG(_a_, ...) \ #define ASSERT_MSG(_a_, ...) \
do \ do { \
if (!(_a_)) { \ if (std::is_constant_evaluated()) { \
assert_noinline_call([&] { LOG_CRITICAL(Debug, "Assertion Failed!\n" __VA_ARGS__); }); \ if (!(_a_)) { \
/* Will trigger compile error here */ \
assert_check_condition(bool(_a_), \
[] { LOG_CRITICAL(Debug, "Assertion Failed!"); }); \
} \
} else { \
assert_check_condition( \
bool(_a_), [&] { LOG_CRITICAL(Debug, "Assertion Failed!\n" __VA_ARGS__); }); \
} \ } \
while (0) } while (0)
#define UNREACHABLE() \ #define UNREACHABLE() \
do { \ do { \
assert_noinline_call([] { LOG_CRITICAL(Debug, "Unreachable code!"); }); \ LOG_CRITICAL(Debug, "Unreachable code!"); \
unreachable_impl(); \ unreachable_impl(); \
} while (0) } while (0)
#define UNREACHABLE_MSG(...) \ #define UNREACHABLE_MSG(...) \
do { \ do { \
assert_noinline_call([&] { LOG_CRITICAL(Debug, "Unreachable code!\n" __VA_ARGS__); }); \ LOG_CRITICAL(Debug, "Unreachable code!\n" __VA_ARGS__); \
unreachable_impl(); \ unreachable_impl(); \
} while (0) } while (0)