2020-12-28 16:15:37 +01:00
|
|
|
// Copyright 2013 Dolphin Emulator Project / 2014 Citra Emulator Project
|
|
|
|
|
// Licensed under GPLv2 or any later version
|
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
#include "common/logging/log.h"
|
|
|
|
|
|
2021-04-08 00:30:26 +02:00
|
|
|
// 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
|
|
|
|
|
// everywhere. So let's just move the handling of the failed assert to a single cpp file.
|
|
|
|
|
void assert_handle_failure();
|
|
|
|
|
|
2020-12-28 16:15:37 +01:00
|
|
|
// 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
|
|
|
|
|
// lambda and force the compiler to not inline it. Unfortunately, MSVC seems to have no syntax to
|
|
|
|
|
// specify __declspec on lambda functions, so what we do instead is define a noinline wrapper
|
|
|
|
|
// 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
|
|
|
|
|
// enough for our purposes.
|
|
|
|
|
template <typename Fn>
|
|
|
|
|
#if defined(_MSC_VER)
|
2021-04-08 00:30:26 +02:00
|
|
|
[[msvc::noinline]]
|
2020-12-28 16:15:37 +01:00
|
|
|
#elif defined(__GNUC__)
|
2021-04-08 00:30:26 +02:00
|
|
|
[[gnu::cold, gnu::noinline]]
|
2020-12-28 16:15:37 +01:00
|
|
|
#endif
|
|
|
|
|
static void
|
|
|
|
|
assert_noinline_call(const Fn& fn) {
|
|
|
|
|
fn();
|
2021-04-08 00:30:26 +02:00
|
|
|
assert_handle_failure();
|
2020-12-28 16:15:37 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#define ASSERT(_a_) \
|
2021-04-08 00:30:26 +02:00
|
|
|
do \
|
|
|
|
|
if (!(_a_)) { \
|
|
|
|
|
assert_noinline_call([] { LOG_CRITICAL(Debug, "Assertion Failed!"); }); \
|
|
|
|
|
} \
|
|
|
|
|
while (0)
|
2020-12-28 16:15:37 +01:00
|
|
|
|
|
|
|
|
#define ASSERT_MSG(_a_, ...) \
|
2021-04-08 00:30:26 +02:00
|
|
|
do \
|
|
|
|
|
if (!(_a_)) { \
|
|
|
|
|
assert_noinline_call([&] { LOG_CRITICAL(Debug, "Assertion Failed!\n" __VA_ARGS__); }); \
|
|
|
|
|
} \
|
|
|
|
|
while (0)
|
2020-12-28 16:15:37 +01:00
|
|
|
|
2021-04-08 00:30:26 +02:00
|
|
|
#define UNREACHABLE() assert_noinline_call([] { LOG_CRITICAL(Debug, "Unreachable code!"); })
|
2020-12-28 16:15:37 +01:00
|
|
|
#define UNREACHABLE_MSG(...) \
|
2021-04-08 00:30:26 +02:00
|
|
|
assert_noinline_call([&] { LOG_CRITICAL(Debug, "Unreachable code!\n" __VA_ARGS__); })
|
2020-12-28 16:15:37 +01:00
|
|
|
|
|
|
|
|
#ifdef _DEBUG
|
|
|
|
|
#define DEBUG_ASSERT(_a_) ASSERT(_a_)
|
|
|
|
|
#define DEBUG_ASSERT_MSG(_a_, ...) ASSERT_MSG(_a_, __VA_ARGS__)
|
|
|
|
|
#else // not debug
|
|
|
|
|
#define DEBUG_ASSERT(_a_)
|
|
|
|
|
#define DEBUG_ASSERT_MSG(_a_, _desc_, ...)
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#define UNIMPLEMENTED() ASSERT_MSG(false, "Unimplemented code!")
|
|
|
|
|
#define UNIMPLEMENTED_MSG(...) ASSERT_MSG(false, __VA_ARGS__)
|
|
|
|
|
|
|
|
|
|
#define UNIMPLEMENTED_IF(cond) ASSERT_MSG(!(cond), "Unimplemented code!")
|
|
|
|
|
#define UNIMPLEMENTED_IF_MSG(cond, ...) ASSERT_MSG(!(cond), __VA_ARGS__)
|
|
|
|
|
|
|
|
|
|
// If the assert is ignored, execute _b_
|
|
|
|
|
#define ASSERT_OR_EXECUTE(_a_, _b_) \
|
|
|
|
|
do { \
|
|
|
|
|
ASSERT(_a_); \
|
|
|
|
|
if (!(_a_)) { \
|
|
|
|
|
_b_ \
|
|
|
|
|
} \
|
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
|
|
// If the assert is ignored, execute _b_
|
|
|
|
|
#define ASSERT_OR_EXECUTE_MSG(_a_, _b_, ...) \
|
|
|
|
|
do { \
|
|
|
|
|
ASSERT_MSG(_a_, __VA_ARGS__); \
|
|
|
|
|
if (!(_a_)) { \
|
|
|
|
|
_b_ \
|
|
|
|
|
} \
|
|
|
|
|
} while (0)
|
