fa6ef701ad
The utility is primarily useful to dereference pointer types, which are known to be not null at that time. For example, the ArgsManager is known to exist when the wallets are started. Instead of silently relying on that assumption, Assert can be used to abort the program and avoid UB should the assumption ever be violated.
60 lines
2.3 KiB
C++
60 lines
2.3 KiB
C++
// Copyright (c) 2019 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_UTIL_CHECK_H
|
|
#define BITCOIN_UTIL_CHECK_H
|
|
|
|
#if defined(HAVE_CONFIG_H)
|
|
#include <config/bitcoin-config.h>
|
|
#endif
|
|
|
|
#include <tinyformat.h>
|
|
|
|
#include <stdexcept>
|
|
|
|
class NonFatalCheckError : public std::runtime_error
|
|
{
|
|
using std::runtime_error::runtime_error;
|
|
};
|
|
|
|
/**
|
|
* Throw a NonFatalCheckError when the condition evaluates to false
|
|
*
|
|
* This should only be used
|
|
* - where the condition is assumed to be true, not for error handling or validating user input
|
|
* - where a failure to fulfill the condition is recoverable and does not abort the program
|
|
*
|
|
* For example in RPC code, where it is undesirable to crash the whole program, this can be generally used to replace
|
|
* asserts or recoverable logic errors. A NonFatalCheckError in RPC code is caught and passed as a string to the RPC
|
|
* caller, which can then report the issue to the developers.
|
|
*/
|
|
#define CHECK_NONFATAL(condition) \
|
|
do { \
|
|
if (!(condition)) { \
|
|
throw NonFatalCheckError( \
|
|
strprintf("%s:%d (%s)\n" \
|
|
"Internal bug detected: '%s'\n" \
|
|
"You may report this issue here: %s\n", \
|
|
__FILE__, __LINE__, __func__, \
|
|
(#condition), \
|
|
PACKAGE_BUGREPORT)); \
|
|
} \
|
|
} while (false)
|
|
|
|
#if defined(NDEBUG)
|
|
#error "Cannot compile without assertions!"
|
|
#endif
|
|
|
|
/** Helper for Assert(). TODO remove in C++14 and replace `decltype(get_pure_r_value(val))` with `T` (templated lambda) */
|
|
template <typename T>
|
|
T get_pure_r_value(T&& val)
|
|
{
|
|
return std::forward<T>(val);
|
|
}
|
|
|
|
/** Identity function. Abort if the value compares equal to zero */
|
|
#define Assert(val) [&]() -> decltype(get_pure_r_value(val))& { auto& check = (val); assert(#val && check); return check; }()
|
|
|
|
#endif // BITCOIN_UTIL_CHECK_H
|