Add branch prediction to Ensures / Expects

We should be using branch prediction on asserts as these conditions are known to be unlikely, therefore we should be optimizing the likely case. These macros are similar to what the Linux kernel uses. Not really sure what Visual Studio does so at the moment these are disabled for VS.
This commit is contained in:
Rian Quinn 2016-09-28 09:43:13 -06:00 committed by GitHub
parent 348a859547
commit 4b29878d70

View File

@ -38,6 +38,14 @@
#define GSL_STRINGIFY_DETAIL(x) #x #define GSL_STRINGIFY_DETAIL(x) #x
#define GSL_STRINGIFY(x) GSL_STRINGIFY_DETAIL(x) #define GSL_STRINGIFY(x) GSL_STRINGIFY_DETAIL(x)
#if defined(__clang__) || defined(__GNUC__)
#define GSL_LIKELY(x) __builtin_expect (!!(x), 1)
#define GSL_UNLIKELY(x) __builtin_expect (!!(x), 0)
#else
#define GSL_LIKELY(x)
#define GSL_UNLIKELY(x)
#endif
// //
// GSL.assert: assertions // GSL.assert: assertions
// //
@ -53,19 +61,19 @@ struct fail_fast : public std::runtime_error
#if defined(GSL_THROW_ON_CONTRACT_VIOLATION) #if defined(GSL_THROW_ON_CONTRACT_VIOLATION)
#define Expects(cond) \ #define Expects(cond) \
if (!(cond)) \ if (GSL_UNLIKELY(!(cond))) \
throw gsl::fail_fast("GSL: Precondition failure at " __FILE__ ": " GSL_STRINGIFY(__LINE__)); throw gsl::fail_fast("GSL: Precondition failure at " __FILE__ ": " GSL_STRINGIFY(__LINE__));
#define Ensures(cond) \ #define Ensures(cond) \
if (!(cond)) \ if (GSL_UNLIKELY(!(cond))) \
throw gsl::fail_fast("GSL: Postcondition failure at " __FILE__ \ throw gsl::fail_fast("GSL: Postcondition failure at " __FILE__ \
": " GSL_STRINGIFY(__LINE__)); ": " GSL_STRINGIFY(__LINE__));
#elif defined(GSL_TERMINATE_ON_CONTRACT_VIOLATION) #elif defined(GSL_TERMINATE_ON_CONTRACT_VIOLATION)
#define Expects(cond) \ #define Expects(cond) \
if (!(cond)) std::terminate(); if (GSL_UNLIKELY(!(cond))) std::terminate();
#define Ensures(cond) \ #define Ensures(cond) \
if (!(cond)) std::terminate(); if (GSL_UNLIKELY(!(cond))) std::terminate();
#elif defined(GSL_UNENFORCED_ON_CONTRACT_VIOLATION) #elif defined(GSL_UNENFORCED_ON_CONTRACT_VIOLATION)