diff --git a/src/compat/assumptions.h b/src/compat/assumptions.h index c5dc6cdab..f70506aac 100644 --- a/src/compat/assumptions.h +++ b/src/compat/assumptions.h @@ -1,106 +1,102 @@ // Copyright (c) 2009-2010 Satoshi Nakamoto // Copyright (c) 2009-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. // Compile-time verification of assumptions we make. #ifndef BITCOIN_COMPAT_ASSUMPTIONS_H #define BITCOIN_COMPAT_ASSUMPTIONS_H #include #include #include #include // Assumption: We assume that the macro NDEBUG is not defined. // Example(s): We use assert(...) extensively with the assumption of it never // being a noop at runtime. #if defined(NDEBUG) #error "Bitcoin cannot be compiled without assertions." #endif // Assumption: We assume a C++17 (ISO/IEC 14882:2017) compiler (minimum // requirement). -// Example(s): We use std::make_unique() through the codebase. -// Note: MSVC does not report the expected __cplusplus value due to -// legacy reasons. -#if !defined(_MSC_VER) -// N3936* ยง16.8 [cpp.predefined]/p1:: -// "The name __cplusplus is defined to the value 201402L when compiling a C++ +// Example(s): We assume the presence of C++17 features everywhere :-) +// ISO Standard C++17 [cpp.predefined]p1: +// "The name __cplusplus is defined to the value 201703L when compiling a C++ // translation unit." static_assert(__cplusplus >= 201703L, "C++17 standard assumed"); -#endif // Assumption: We assume the floating-point types to fulfill the requirements of // IEC 559 (IEEE 754) standard. // Example(s): Floating-point division by zero in ConnectBlock, // CreateTransaction // and EstimateMedianVal. static_assert(std::numeric_limits::is_iec559, "IEEE 754 float assumed"); static_assert(std::numeric_limits::is_iec559, "IEEE 754 double assumed"); // Assumption: We assume floating-point widths. // Example(s): Type punning in serialization code // (ser_{float,double}_to_uint{32,64}). static_assert(sizeof(float) == 4, "32-bit float assumed"); static_assert(sizeof(double) == 8, "64-bit double assumed"); // Assumption: We assume integer widths. // Example(s): GetSizeOfCompactSize and WriteCompactSize in the serialization // code. static_assert(sizeof(short) == 2, "16-bit short assumed"); static_assert(sizeof(int) == 4, "32-bit int assumed"); static_assert(sizeof(unsigned) == 4, "32-bit unsigned assumed"); // Assumption: We assume 8-bit bytes, because 32-bit int and 16-bit short are // assumed. static_assert(CHAR_BIT == 8, "8-bit bytes assumed"); // Assumption: We assume uint8_t is an alias of unsigned char. // char, unsigned char, and std::byte (C++17) are the only "byte types" // according to the C++ Standard. "byte type" means a type that can be used to // observe an object's value representation. We use uint8_t everywhere to see // bytes, so we have to ensure that uint8_t is an alias to a "byte type". // http://eel.is/c++draft/basic.types // http://eel.is/c++draft/basic.memobj#def:byte // http://eel.is/c++draft/expr.sizeof#1 // http://eel.is/c++draft/cstdint#syn static_assert(std::is_same::value, "uint8_t is an alias of unsigned char"); // Assumption: We assume size_t to be 32-bit or 64-bit. // Example(s): size_t assumed to be at least 32-bit in // ecdsa_signature_parse_der_lax(...). // size_t assumed to be 32-bit or 64-bit in MallocUsage(...). static_assert(sizeof(size_t) == 4 || sizeof(size_t) == 8, "size_t assumed to be 32-bit or 64-bit"); static_assert(sizeof(size_t) == sizeof(void *), "Sizes of size_t and void* assumed to be equal"); // Some important things we are NOT assuming (non-exhaustive list): // * We are NOT assuming a specific value for std::endian::native. // * We are NOT assuming a specific value for std::locale("").name(). // * We are NOT assuming a specific value for // std::numeric_limits::is_signed. /** * /!\ C++ right shift signedness handling is implementation defined. It is * defined as an arithmetic on all the platform we support, but this * may not be the case on other platforms. * * NB: C++20 defines signed right shift as being arithmetic shifts, so in * practice, we should see all platforms converge toward that behavior if * they haven't already. */ static_assert((int64_t(-1) >> 1) == int64_t(-1), "Arithmetic right shift assumed"); /** * /!\ C++ Does not guarantee 2-complement, but it implementation defined. All * the platform we support use 2-complement. */ static_assert((int64_t(-10) & 0xffff) == 0xfff6, "2-complement assumed"); #endif // BITCOIN_COMPAT_ASSUMPTIONS_H