Skip to content

S
swiftshader
Commit 60aa34a9 by Nicolas Capens Committed by Nicolas Capens
Options

Omit ASSERT() expression evaluation in Release builds

Bug: b/154914395 Change-Id: Ib90d86d83e3f8b17749f9eeecaedd320f991bd86 Reviewed-on: https://swiftshader-review.googlesource.com/c/SwiftShader/+/44348 Presubmit-Ready: Nicolas Capens <nicolascapens@google.com> Reviewed-by: 's avatarAntonio Maiorano <amaiorano@google.com> Tested-by: 's avatarNicolas Capens <nicolascapens@google.com>
parent f42c698d
Showing with 80 additions and 38 deletions
src/Reactor/Debug.hpp
...@@ -64,10 +64,10 @@ void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS; ...@@ -64,10 +64,10 @@ void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS;
// A macro to print a warning message to the debugging log and stderr to denote // A macro to print a warning message to the debugging log and stderr to denote
// an issue that needs fixing. // an issue that needs fixing.
#define FIXME(message, ...) rr::warn("%s:%d FIXME: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__); #define FIXME(message, ...) rr::warn("%s:%d FIXME: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
// A macro to print a warning message to the debugging log and stderr. // A macro to print a warning message to the debugging log and stderr.
#define WARN(message, ...) rr::warn("%s:%d WARNING: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__); #define WARN(message, ...) rr::warn("%s:%d WARNING: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
// A macro that prints the message to the debugging log and stderr and // A macro that prints the message to the debugging log and stderr and
// immediately aborts execution of the application. // immediately aborts execution of the application.
...@@ -91,26 +91,46 @@ void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS; ...@@ -91,26 +91,46 @@ void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS;
// A macro asserting a condition. // A macro asserting a condition.
// If the condition fails, the condition and message is passed to DABORT(). // If the condition fails, the condition and message is passed to DABORT().
#undef ASSERT_MSG #undef ASSERT_MSG
#define ASSERT_MSG(expression, format, ...) \ #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
do \ # define ASSERT_MSG(expression, format, ...) \
{ \ do \
if(!(expression)) \ { \
{ \ if(!(expression)) \
DABORT("ASSERT(%s): " format "\n", #expression, ##__VA_ARGS__); \ { \
} \ DABORT("ASSERT(%s): " format "\n", #expression, ##__VA_ARGS__); \
} while(0) } \
} while(0)
#else
// Silence unused variable warnings without evaluating the expressions.
// TODO(b/154914395): Also ignore variadic arguments (similar to RR_WATCH expansion)
# define ASSERT_MSG(expression, format, ...) \
do \
{ \
(void)sizeof((int)(bool)(expression)); \
(void)sizeof(format); \
} while(0)
#endif
// A macro asserting a condition. // A macro asserting a condition.
// If the condition fails, the condition is passed to DABORT(). // If the condition fails, the condition is passed to DABORT().
#undef ASSERT #undef ASSERT
#define ASSERT(expression) \ #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
do \ # define ASSERT(expression) \
{ \ do \
if(!(expression)) \ { \
{ \ if(!(expression)) \
DABORT("ASSERT(%s)\n", #expression); \ { \
} \ DABORT("ASSERT(%s)\n", #expression); \
} while(0) } \
} while(0)
#else
// Silence unused variable warnings without evaluating the expressions.
# define ASSERT(expression) \
do \
{ \
(void)sizeof((int)(bool)(expression)); \
} while(0)
#endif
// A macro to indicate functionality currently unimplemented, for a feature advertised // A macro to indicate functionality currently unimplemented, for a feature advertised
// as supported. This is similar to UNIMPLEMENTED() but does not check there's a bug // as supported. This is similar to UNIMPLEMENTED() but does not check there's a bug
...@@ -140,7 +160,8 @@ void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS; ...@@ -140,7 +160,8 @@ void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS;
#undef UNREACHABLE #undef UNREACHABLE
#define UNREACHABLE(format, ...) DABORT("UNREACHABLE: " format, ##__VA_ARGS__) #define UNREACHABLE(format, ...) DABORT("UNREACHABLE: " format, ##__VA_ARGS__)
// A macro asserting a condition and performing a return. // A macro asserting a condition and returning if false.
// Note this macro always evaluates the expression and also returns in Release builds.
#undef ASSERT_OR_RETURN #undef ASSERT_OR_RETURN
#if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON) #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
# define ASSERT_OR_RETURN(expression) ASSERT(expression) # define ASSERT_OR_RETURN(expression) ASSERT(expression)
......
src/System/Debug.hpp
...@@ -64,10 +64,10 @@ void log_trap(const char *format, ...) CHECK_PRINTF_ARGS; ...@@ -64,10 +64,10 @@ void log_trap(const char *format, ...) CHECK_PRINTF_ARGS;
// A macro to print a warning message to the debugging log and stderr to denote // A macro to print a warning message to the debugging log and stderr to denote
// an issue that needs fixing. // an issue that needs fixing.
#define FIXME(message, ...) sw::warn("%s:%d FIXME: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__); #define FIXME(message, ...) sw::warn("%s:%d FIXME: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
// A macro to print a warning message to the debugging log and stderr. // A macro to print a warning message to the debugging log and stderr.
#define WARN(message, ...) sw::warn("%s:%d WARNING: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__); #define WARN(message, ...) sw::warn("%s:%d WARNING: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
// A macro that prints the message to the debugging log and stderr and // A macro that prints the message to the debugging log and stderr and
// immediately aborts execution of the application. // immediately aborts execution of the application.
...@@ -91,26 +91,46 @@ void log_trap(const char *format, ...) CHECK_PRINTF_ARGS; ...@@ -91,26 +91,46 @@ void log_trap(const char *format, ...) CHECK_PRINTF_ARGS;
// A macro asserting a condition. // A macro asserting a condition.
// If the condition fails, the condition and message is passed to DABORT(). // If the condition fails, the condition and message is passed to DABORT().
#undef ASSERT_MSG #undef ASSERT_MSG
#define ASSERT_MSG(expression, format, ...) \ #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
do \ # define ASSERT_MSG(expression, format, ...) \
{ \ do \
if(!(expression)) \ { \
{ \ if(!(expression)) \
DABORT("ASSERT(%s): " format "\n", #expression, ##__VA_ARGS__); \ { \
} \ DABORT("ASSERT(%s): " format "\n", #expression, ##__VA_ARGS__); \
} while(0) } \
} while(0)
#else
// Silence unused variable warnings without evaluating the expressions.
// TODO(b/154914395): Also ignore variadic arguments (similar to RR_WATCH expansion)
# define ASSERT_MSG(expression, format, ...) \
do \
{ \
(void)sizeof((int)(bool)(expression)); \
(void)sizeof(format); \
} while(0)
#endif
// A macro asserting a condition. // A macro asserting a condition.
// If the condition fails, the condition is passed to DABORT(). // If the condition fails, the condition is passed to DABORT().
#undef ASSERT #undef ASSERT
#define ASSERT(expression) \ #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
do \ # define ASSERT(expression) \
{ \ do \
if(!(expression)) \ { \
{ \ if(!(expression)) \
DABORT("ASSERT(%s)\n", #expression); \ { \
} \ DABORT("ASSERT(%s)\n", #expression); \
} while(0) } \
} while(0)
#else
// Silence unused variable warnings without evaluating the expressions.
# define ASSERT(expression) \
do \
{ \
(void)sizeof((int)(bool)(expression)); \
} while(0)
#endif
// A macro to indicate functionality currently unimplemented, for a feature advertised // A macro to indicate functionality currently unimplemented, for a feature advertised
// as supported. Since this is a bug, a bug ID must be provided, in b/### format. // as supported. Since this is a bug, a bug ID must be provided, in b/### format.
...@@ -133,7 +153,8 @@ void log_trap(const char *format, ...) CHECK_PRINTF_ARGS; ...@@ -133,7 +153,8 @@ void log_trap(const char *format, ...) CHECK_PRINTF_ARGS;
#undef UNREACHABLE #undef UNREACHABLE
#define UNREACHABLE(format, ...) DABORT("UNREACHABLE: " format, ##__VA_ARGS__) #define UNREACHABLE(format, ...) DABORT("UNREACHABLE: " format, ##__VA_ARGS__)
// A macro asserting a condition and performing a return. // A macro asserting a condition and returning if false.
// Note this macro always evaluates the expression and also returns in Release builds.
#undef ASSERT_OR_RETURN #undef ASSERT_OR_RETURN
#if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON) #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
# define ASSERT_OR_RETURN(expression) ASSERT(expression) # define ASSERT_OR_RETURN(expression) ASSERT(expression)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment