1 // Copyright 2016 The SwiftShader Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 // debug.h: Debugging utilities.
16
17 #ifndef rr_DEBUG_H_
18 #define rr_DEBUG_H_
19
20 #include <assert.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23
24 #include <cctype>
25 #include <string>
26
27 #if !defined(TRACE_OUTPUT_FILE)
28 # define TRACE_OUTPUT_FILE "debug.txt"
29 #endif
30
31 #if defined(__GNUC__) || defined(__clang__)
32 # define CHECK_PRINTF_ARGS __attribute__((format(printf, 1, 2)))
33 #else
34 # define CHECK_PRINTF_ARGS
35 #endif
36
37 namespace rr {
38
39 // Outputs text to the debugging log
40 void trace(const char *format, ...) CHECK_PRINTF_ARGS;
trace()41 inline void trace() {}
42
43 // Outputs text to the debugging log and prints to stderr.
44 void warn(const char *format, ...) CHECK_PRINTF_ARGS;
warn()45 inline void warn() {}
46
47 // Outputs the message to the debugging log and stderr, and calls abort().
48 void abort(const char *format, ...) CHECK_PRINTF_ARGS;
49
50 // Outputs text to the debugging log, and asserts once if a debugger is attached.
51 void trace_assert(const char *format, ...) CHECK_PRINTF_ARGS;
52
53 } // namespace rr
54
55 // A macro to output a trace of a function call and its arguments to the
56 // debugging log. Disabled if RR_DISABLE_TRACE is defined.
57 #if defined(RR_DISABLE_TRACE)
58 # define TRACE(message, ...) (void(0))
59 # define TRACE_ASSERT(message, ...) (void(0))
60 #else
61 # define TRACE(message, ...) rr::trace("%s:%d TRACE: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
62 # define TRACE_ASSERT(message, ...) rr::trace_assert("%s:%d %s TRACE_ASSERT: " message "\n", __FILE__, __LINE__, __func__, ##__VA_ARGS__)
63 #endif
64
65 // A macro to print a warning message to the debugging log and stderr to denote
66 // an issue that needs fixing.
67 #define FIXME(message, ...) rr::warn("%s:%d FIXME: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
68
69 // A macro to print a warning message to the debugging log and stderr.
70 #define WARN(message, ...) rr::warn("%s:%d WARNING: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
71
72 // A macro that delegates to:
73 // abort() in debug builds (!NDEBUG || DCHECK_ALWAYS_ON)
74 // or
75 // warn() in release builds (NDEBUG && !DCHECK_ALWAYS_ON)
76 #undef DABORT
77 #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
78 # define DABORT(message, ...) rr::abort("%s:%d ABORT: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__)
79 #else
80 # define DABORT(message, ...) rr::warn("%s:%d WARNING: " message "\n", __FILE__, __LINE__, ##__VA_ARGS__);
81 #endif
82
83 // A macro asserting a condition.
84 // If the condition fails, the condition and message is passed to DABORT().
85 #undef ASSERT_MSG
86 #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
87 # define ASSERT_MSG(expression, format, ...) \
88 do \
89 { \
90 if(!(expression)) \
91 { \
92 DABORT("ASSERT(%s): " format "\n", #expression, ##__VA_ARGS__); \
93 } \
94 } while(0)
95 #else
96 // Silence unused variable warnings without evaluating the expressions.
97 // TODO(b/154914395): Also ignore variadic arguments (similar to RR_WATCH expansion)
98 # define ASSERT_MSG(expression, format, ...) \
99 do \
100 { \
101 (void)sizeof((int)(bool)(expression)); \
102 (void)sizeof(format); \
103 } while(0)
104 #endif
105
106 // A macro asserting a condition.
107 // If the condition fails, the condition is passed to DABORT().
108 #undef ASSERT
109 #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
110 # define ASSERT(expression) \
111 do \
112 { \
113 if(!(expression)) \
114 { \
115 DABORT("ASSERT(%s)\n", #expression); \
116 } \
117 } while(0)
118 #else
119 // Silence unused variable warnings without evaluating the expressions.
120 # define ASSERT(expression) \
121 do \
122 { \
123 (void)sizeof((int)(bool)(expression)); \
124 } while(0)
125 #endif
126
127 // A macro to indicate functionality currently unimplemented, for a feature advertised
128 // as supported. This is similar to UNIMPLEMENTED() but does not check there's a bug
129 // number.
130 #undef UNIMPLEMENTED_NO_BUG
131 #define UNIMPLEMENTED_NO_BUG(format, ...) \
132 DABORT("UNIMPLEMENTED: " format, ##__VA_ARGS__);
133
134 // A macro to indicate functionality currently unimplemented, for a feature advertised
135 // as supported. Since this is a bug, a bug ID must be provided, in b/### format.
136 // For unimplemented functionality not advertised as supported, use UNSUPPORTED() instead.
137 #undef UNIMPLEMENTED
138 #define UNIMPLEMENTED(format, ...) \
139 static_assert(format[0] == 'b' && format[1] == '/' && format[2] >= '0' && format[2] <= '9', "explanation must start with bug reference in b/### format"); \
140 UNIMPLEMENTED_NO_BUG(format, ##__VA_ARGS__)
141
142 // A macro to indicate unsupported functionality.
143 // This should be called when a feature is attempted to be used, but is not
144 // currently implemented by Reactor.
145 // Note that in a well-behaved application these should not be reached as the
146 // application should be respecting the advertised features / limits.
147 #undef UNSUPPORTED
148 #define UNSUPPORTED(format, ...) DABORT("UNSUPPORTED: " format, ##__VA_ARGS__)
149
150 // A macro for code which should never be reached, even with misbehaving
151 // applications.
152 #undef UNREACHABLE
153 #define UNREACHABLE(format, ...) DABORT("UNREACHABLE: " format, ##__VA_ARGS__)
154
155 // A macro asserting a condition and returning if false.
156 // Note this macro always evaluates the expression and also returns in Release builds.
157 #undef ASSERT_OR_RETURN
158 #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
159 # define ASSERT_OR_RETURN(expression) ASSERT(expression)
160 #else
161 # define ASSERT_OR_RETURN(expression) \
162 do \
163 { \
164 if(!(expression)) \
165 { \
166 return; \
167 } \
168 } while(0)
169 #endif
170
171 #endif // rr_DEBUG_H_
172