2019-09-23 14:45:51 -04:00
|
|
|
// 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
|
|
|
|
|
|
2020-04-17 11:15:55 -04:00
|
|
|
#if defined(HAVE_CONFIG_H)
|
|
|
|
|
#include <config/bitcoin-config.h>
|
|
|
|
|
#endif
|
|
|
|
|
|
2019-09-23 14:45:51 -04:00
|
|
|
#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 undersirable 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)
|
|
|
|
|
|
|
|
|
|
#endif // BITCOIN_UTIL_CHECK_H
|
