1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
/*
* Copyright (C) 2003, 2006, 2007 Apple Inc. All rights reserved.
* Copyright (C) 2013 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WTF_Assertions_h
#define WTF_Assertions_h
// This file uses some GCC extensions, but it should be compatible with C++ and
// Objective C++.
//
// For non-debug builds, everything is disabled by default, except for the
// RELEASE_ASSERT family of macros.
#include "base/allocator/oom.h"
#include "base/gtest_prod_util.h"
#include "base/logging.h"
#include "wtf/Compiler.h"
#include "wtf/Noncopyable.h"
#include "wtf/WTFExport.h"
#include "wtf/build_config.h"
#include <stdarg.h>
#if OS(WIN)
#include <windows.h>
#endif
#ifndef LOG_DISABLED
#define LOG_DISABLED !DCHECK_IS_ON()
#endif
// These helper functions are always declared, but not necessarily always
// defined if the corresponding function is disabled.
WTF_EXPORT void WTFReportAssertionFailure(const char* file,
int line,
const char* function,
const char* assertion);
// WTFLogAlways() is deprecated. crbug.com/638849
WTF_EXPORT PRINTF_FORMAT(1, 2) void WTFLogAlways(const char* format, ...);
WTF_EXPORT void WTFReportBacktrace(int framesToShow = 31);
namespace WTF {
#if LOG_DISABLED
#define WTF_CREATE_SCOPED_LOGGER(...) ((void)0)
#define WTF_CREATE_SCOPED_LOGGER_IF(...) ((void)0)
#define WTF_APPEND_SCOPED_LOGGER(...) ((void)0)
#else
// ScopedLogger wraps log messages in parentheses, with indentation proportional
// to the number of instances. This makes it easy to see the flow of control in
// the output, particularly when instrumenting recursive functions.
//
// NOTE: This class is a debugging tool, not intended for use by checked-in
// code. Please do not remove it.
//
class WTF_EXPORT ScopedLogger {
WTF_MAKE_NONCOPYABLE(ScopedLogger);
public:
// The first message is passed to the constructor. Additional messages for
// the same scope can be added with log(). If condition is false, produce no
// output and do not create a scope.
PRINTF_FORMAT(3, 4) ScopedLogger(bool condition, const char* format, ...);
~ScopedLogger();
PRINTF_FORMAT(2, 3) void log(const char* format, ...);
private:
FRIEND_TEST_ALL_PREFIXES(AssertionsTest, ScopedLogger);
using PrintFunctionPtr = void (*)(const char* format, va_list args);
static void setPrintFuncForTests(PrintFunctionPtr p) {
m_printFunc = p;
} // Note: not thread safe.
void init(const char* format, va_list args);
void writeNewlineIfNeeded();
void indent();
void print(const char* format, ...);
void printIndent();
static ScopedLogger*& current();
ScopedLogger* const m_parent;
bool m_multiline; // The ')' will go on the same line if there is only one
// entry.
static PrintFunctionPtr m_printFunc;
};
#define WTF_CREATE_SCOPED_LOGGER(name, ...) \
WTF::ScopedLogger name(true, __VA_ARGS__)
#define WTF_CREATE_SCOPED_LOGGER_IF(name, condition, ...) \
WTF::ScopedLogger name(condition, __VA_ARGS__)
#define WTF_APPEND_SCOPED_LOGGER(name, ...) (name.log(__VA_ARGS__))
#endif // LOG_DISABLED
} // namespace WTF
// CRASH() - Raises a fatal error resulting in program termination and
// triggering either the debugger or the crash reporter.
//
// Use CRASH() in response to known, unrecoverable errors like out-of-memory.
// Macro is enabled in both debug and release mode.
// To test for unknown errors and verify assumptions, use ASSERT instead, to
// avoid impacting performance in release builds.
#ifndef CRASH
#define CRASH() IMMEDIATE_CRASH()
#endif
// ASSERT and ASSERT_NOT_REACHED
// These macros are compiled out of release builds.
// Expressions inside them are evaluated in debug builds only.
// They are deprecated. We should use:
// - DCHECK() for ASSERT()
// - NOTREACHED() for ASSERT_NOT_REACHED()
#if OS(WIN)
// FIXME: Change to use something other than ASSERT to avoid this conflict with
// the underlying platform.
#undef ASSERT
#endif
#define DCHECK_AT(assertion, file, line) \
LAZY_STREAM(logging::LogMessage(file, line, #assertion).stream(), \
DCHECK_IS_ON() ? !(assertion) : false)
#if DCHECK_IS_ON()
#define ASSERT(assertion) DCHECK(assertion)
#define ASSERT_NOT_REACHED() NOTREACHED()
#else
#define ASSERT(assertion) ((void)0)
#define ASSERT_NOT_REACHED() ((void)0)
#endif
// Users must test "#if ENABLE(SECURITY_ASSERT)", which helps ensure
// that code testing this macro has included this header.
#if defined(ADDRESS_SANITIZER) || DCHECK_IS_ON()
#define ENABLE_SECURITY_ASSERT 1
#else
#define ENABLE_SECURITY_ASSERT 0
#endif
// SECURITY_DCHECK and SECURITY_CHECK
// Use in places where failure of the assertion indicates a possible security
// vulnerability. Classes of these vulnerabilities include bad casts, out of
// bounds accesses, use-after-frees, etc. Please be sure to file bugs for these
// failures using the security template:
// https://bugs.chromium.org/p/chromium/issues/entry?template=Security%20Bug
#if ENABLE_SECURITY_ASSERT
#define SECURITY_DCHECK(condition) \
LOG_IF(FATAL, !(condition)) << "Security DCHECK failed: " #condition ". "
// A SECURITY_CHECK failure is actually not vulnerable.
#define SECURITY_CHECK(condition) \
LOG_IF(FATAL, !(condition)) << "Security CHECK failed: " #condition ". "
#else
#define SECURITY_DCHECK(condition) ((void)0)
#define SECURITY_CHECK(condition) CHECK(condition)
#endif
// RELEASE_ASSERT
// Use in places where failure of an assertion indicates a definite security
// vulnerability from which execution must not continue even in a release build.
// Please sure to file bugs for these failures using the security template:
// http://code.google.com/p/chromium/issues/entry?template=Security%20Bug
#if defined(ADDRESS_SANITIZER)
#define RELEASE_ASSERT(condition) SECURITY_CHECK(condition)
#else
#define RELEASE_ASSERT(condition) CHECK(condition)
#endif
// DEFINE_COMPARISON_OPERATORS_WITH_REFERENCES
// Allow equality comparisons of Objects by reference or pointer,
// interchangeably. This can be only used on types whose equality makes no
// other sense than pointer equality.
#define DEFINE_COMPARISON_OPERATORS_WITH_REFERENCES(thisType) \
inline bool operator==(const thisType& a, const thisType& b) { \
return &a == &b; \
} \
inline bool operator==(const thisType& a, const thisType* b) { \
return &a == b; \
} \
inline bool operator==(const thisType* a, const thisType& b) { \
return a == &b; \
} \
inline bool operator!=(const thisType& a, const thisType& b) { \
return !(a == b); \
} \
inline bool operator!=(const thisType& a, const thisType* b) { \
return !(a == b); \
} \
inline bool operator!=(const thisType* a, const thisType& b) { \
return !(a == b); \
}
// DEFINE_TYPE_CASTS
//
// toType() functions are static_cast<> wrappers with SECURITY_DCHECK. It's
// helpful to find bad casts.
//
// toTypeOrDie() has a runtime type check, and it crashes if the specified
// object is not an instance of the destination type. It is used if
// * it's hard to prevent from passing unexpected objects,
// * proceeding with the following code doesn't make sense, and
// * cost of runtime type check is acceptable.
#define DEFINE_TYPE_CASTS(thisType, argumentType, argument, pointerPredicate, \
referencePredicate) \
inline thisType* to##thisType(argumentType* argument) { \
SECURITY_DCHECK(!argument || (pointerPredicate)); \
return static_cast<thisType*>(argument); \
} \
inline const thisType* to##thisType(const argumentType* argument) { \
SECURITY_DCHECK(!argument || (pointerPredicate)); \
return static_cast<const thisType*>(argument); \
} \
inline thisType& to##thisType(argumentType& argument) { \
SECURITY_DCHECK(referencePredicate); \
return static_cast<thisType&>(argument); \
} \
inline const thisType& to##thisType(const argumentType& argument) { \
SECURITY_DCHECK(referencePredicate); \
return static_cast<const thisType&>(argument); \
} \
void to##thisType(const thisType*); \
void to##thisType(const thisType&); \
inline thisType* to##thisType##OrDie(argumentType* argument) { \
CHECK(!argument || (pointerPredicate)); \
return static_cast<thisType*>(argument); \
} \
inline const thisType* to##thisType##OrDie(const argumentType* argument) { \
CHECK(!argument || (pointerPredicate)); \
return static_cast<const thisType*>(argument); \
} \
inline thisType& to##thisType##OrDie(argumentType& argument) { \
CHECK(referencePredicate); \
return static_cast<thisType&>(argument); \
} \
inline const thisType& to##thisType##OrDie(const argumentType& argument) { \
CHECK(referencePredicate); \
return static_cast<const thisType&>(argument); \
} \
void to##thisType##OrDie(const thisType*); \
void to##thisType##OrDie(const thisType&)
#endif // WTF_Assertions_h
|
