Bitcoin Core  27.99.0
P2P Digital Currency
check.h
Go to the documentation of this file.
1 // Copyright (c) 2019-2022 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_UTIL_CHECK_H
6 #define BITCOIN_UTIL_CHECK_H
7 
8 #include <attributes.h>
9 
10 #include <cassert> // IWYU pragma: export
11 #include <stdexcept>
12 #include <string>
13 #include <string_view>
14 #include <utility>
15 
16 std::string StrFormatInternalBug(std::string_view msg, std::string_view file, int line, std::string_view func);
17 
18 class NonFatalCheckError : public std::runtime_error
19 {
20 public:
21  NonFatalCheckError(std::string_view msg, std::string_view file, int line, std::string_view func);
22 };
23 
25 template <typename T>
26 T&& inline_check_non_fatal(LIFETIMEBOUND T&& val, const char* file, int line, const char* func, const char* assertion)
27 {
28  if (!val) {
29  throw NonFatalCheckError{assertion, file, line, func};
30  }
31  return std::forward<T>(val);
32 }
33 
34 #if defined(NDEBUG)
35 #error "Cannot compile without assertions!"
36 #endif
37 
39 void assertion_fail(std::string_view file, int line, std::string_view func, std::string_view assertion);
40 
42 template <bool IS_ASSERT, typename T>
43 T&& inline_assertion_check(LIFETIMEBOUND T&& val, [[maybe_unused]] const char* file, [[maybe_unused]] int line, [[maybe_unused]] const char* func, [[maybe_unused]] const char* assertion)
44 {
45  if constexpr (IS_ASSERT
46 #ifdef ABORT_ON_FAILED_ASSUME
47  || true
48 #endif
49  ) {
50  if (!val) {
51  assertion_fail(file, line, func, assertion);
52  }
53  }
54  return std::forward<T>(val);
55 }
56 
57 // All macros may use __func__ inside a lambda, so put them under nolint.
58 // NOLINTBEGIN(bugprone-lambda-function-name)
59 
60 #define STR_INTERNAL_BUG(msg) StrFormatInternalBug((msg), __FILE__, __LINE__, __func__)
61 
73 #define CHECK_NONFATAL(condition) \
74  inline_check_non_fatal(condition, __FILE__, __LINE__, __func__, #condition)
75 
77 #define Assert(val) inline_assertion_check<true>(val, __FILE__, __LINE__, __func__, #val)
78 
89 #define Assume(val) inline_assertion_check<false>(val, __FILE__, __LINE__, __func__, #val)
90 
94 #define NONFATAL_UNREACHABLE() \
95  throw NonFatalCheckError( \
96  "Unreachable code reached (non-fatal)", __FILE__, __LINE__, __func__)
97 
98 // NOLINTEND(bugprone-lambda-function-name)
99 
100 #endif // BITCOIN_UTIL_CHECK_H
#define LIFETIMEBOUND
Definition: attributes.h:16
std::string StrFormatInternalBug(std::string_view msg, std::string_view file, int line, std::string_view func)
Definition: check.cpp:17
T && inline_check_non_fatal(LIFETIMEBOUND T &&val, const char *file, int line, const char *func, const char *assertion)
Helper for CHECK_NONFATAL()
Definition: check.h:26
void assertion_fail(std::string_view file, int line, std::string_view func, std::string_view assertion)
Helper for Assert()
Definition: check.cpp:30
T && inline_assertion_check(LIFETIMEBOUND T &&val, [[maybe_unused]] const char *file, [[maybe_unused]] int line, [[maybe_unused]] const char *func, [[maybe_unused]] const char *assertion)
Helper for Assert()/Assume()
Definition: check.h:43
NonFatalCheckError(std::string_view msg, std::string_view file, int line, std::string_view func)
Definition: check.cpp:25
#define T(expected, seed, data)