9dcc229dfe
Currently, there's no way to specify if an assertion should conditionally occur due to unimplemented behavior. This is useful when something is only partially implemented (e.g. due to ongoing RE work). In particular, this would be useful within the graphics code. The rationale behind this is it allows a dev to disable unimplemented feature assertions (which can occur in an unrelated work area), while still enabling regular assertions, which act as behavior guards for conditions or states which must not occur. Previously, the only way a dev could temporarily disable asserts, was to disable the regular assertion macros, which has the downside of also disabling, well, the regular assertions which hold more sanitizing value, as opposed to unimplemented feature assertions.
60 lines
2.8 KiB
C++
60 lines
2.8 KiB
C++
// 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 <cstdlib>
|
|
#include "common/common_funcs.h"
|
|
#include "common/logging/log.h"
|
|
|
|
// 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)
|
|
__declspec(noinline, noreturn)
|
|
#elif defined(__GNUC__)
|
|
__attribute__((noinline, noreturn, cold))
|
|
#endif
|
|
static void assert_noinline_call(const Fn& fn) {
|
|
fn();
|
|
Crash();
|
|
exit(1); // Keeps GCC's mouth shut about this actually returning
|
|
}
|
|
|
|
#define ASSERT(_a_) \
|
|
do \
|
|
if (!(_a_)) { \
|
|
assert_noinline_call([] { LOG_CRITICAL(Debug, "Assertion Failed!"); }); \
|
|
} \
|
|
while (0)
|
|
|
|
#define ASSERT_MSG(_a_, ...) \
|
|
do \
|
|
if (!(_a_)) { \
|
|
assert_noinline_call([&] { LOG_CRITICAL(Debug, "Assertion Failed!\n" __VA_ARGS__); }); \
|
|
} \
|
|
while (0)
|
|
|
|
#define UNREACHABLE() ASSERT_MSG(false, "Unreachable code!")
|
|
#define UNREACHABLE_MSG(...) ASSERT_MSG(false, __VA_ARGS__)
|
|
|
|
#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__)
|