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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
base / check.cc [blame]
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/check.h"
#include <optional>
#include "base/check_op.h"
#include "base/check_version_internal.h"
#include "base/debug/alias.h"
#include "base/debug/dump_without_crashing.h"
#include "base/logging.h"
#include "base/thread_annotations.h"
#include "base/types/cxx23_to_underlying.h"
#include "build/build_config.h"
#if BUILDFLAG(IS_NACL)
// Forward declaring this ptr for code simplicity below, we'll never dereference
// it under NaCl.
namespace base::debug {
class CrashKeyString;
} // namespace base::debug
#else
#include "base/debug/crash_logging.h"
#endif // !BUILDFLAG(IS_NACL)
namespace logging {
namespace {
LogSeverity GetDumpSeverity() {
#if defined(OFFICIAL_BUILD)
return DCHECK_IS_ON() ? LOGGING_DCHECK : LOGGING_ERROR;
#else
// Crash outside official builds (outside user-facing builds) to detect
// invariant violations early in release-build testing like fuzzing, etc.
// These should eventually be migrated to fatal CHECKs.
return LOGGING_FATAL;
#endif
}
LogSeverity GetNotFatalUntilSeverity(base::NotFatalUntil fatal_milestone) {
if (fatal_milestone != base::NotFatalUntil::NoSpecifiedMilestoneInternal &&
base::to_underlying(fatal_milestone) <= BASE_CHECK_VERSION_INTERNAL) {
return LOGGING_FATAL;
}
return GetDumpSeverity();
}
LogSeverity GetCheckSeverity(base::NotFatalUntil fatal_milestone) {
// CHECKs are fatal unless `fatal_milestone` overrides it.
if (fatal_milestone == base::NotFatalUntil::NoSpecifiedMilestoneInternal) {
return LOGGING_FATAL;
}
return GetNotFatalUntilSeverity(fatal_milestone);
}
base::debug::CrashKeyString* GetNotReachedCrashKey() {
#if BUILDFLAG(IS_NACL)
return nullptr;
#else
static auto* const key = ::base::debug::AllocateCrashKeyString(
"Logging-NOTREACHED_MESSAGE", base::debug::CrashKeySize::Size1024);
return key;
#endif // BUILDFLAG(IS_NACL)
}
base::debug::CrashKeyString* GetDCheckCrashKey() {
#if BUILDFLAG(IS_NACL)
return nullptr;
#else
static auto* const key = ::base::debug::AllocateCrashKeyString(
"Logging-DCHECK_MESSAGE", base::debug::CrashKeySize::Size1024);
return key;
#endif // BUILDFLAG(IS_NACL)
}
base::debug::CrashKeyString* GetDumpWillBeCheckCrashKey() {
#if BUILDFLAG(IS_NACL)
return nullptr;
#else
static auto* const key = ::base::debug::AllocateCrashKeyString(
"Logging-DUMP_WILL_BE_CHECK_MESSAGE",
base::debug::CrashKeySize::Size1024);
return key;
#endif // BUILDFLAG(IS_NACL)
}
#if !BUILDFLAG(IS_NACL)
base::debug::CrashKeyString* GetFatalMilestoneCrashKey() {
static auto* const key = ::base::debug::AllocateCrashKeyString(
"Logging-FATAL_MILESTONE", base::debug::CrashKeySize::Size32);
return key;
}
#endif // BUILDFLAG(IS_NACL)
void MaybeSetFatalMilestoneCrashKey(base::NotFatalUntil fatal_milestone) {
#if !BUILDFLAG(IS_NACL)
if (fatal_milestone == base::NotFatalUntil::NoSpecifiedMilestoneInternal) {
return;
}
base::debug::SetCrashKeyString(
GetFatalMilestoneCrashKey(),
base::NumberToString(base::to_underlying(fatal_milestone)));
#endif // BUILDFLAG(IS_NACL)
}
void DumpWithoutCrashing(base::debug::CrashKeyString* message_key,
const logging::LogMessage* log_message,
const base::Location& location,
base::NotFatalUntil fatal_milestone) {
const std::string crash_string = log_message->BuildCrashString();
#if !BUILDFLAG(IS_NACL)
base::debug::ScopedCrashKeyString scoped_message_key(message_key,
crash_string);
MaybeSetFatalMilestoneCrashKey(fatal_milestone);
#endif // !BUILDFLAG(IS_NACL)
// Copy the crash message to stack memory to make sure it can be recovered in
// crash dumps. This is easier to recover in minidumps than crash keys during
// local debugging.
DEBUG_ALIAS_FOR_CSTR(log_message_str, crash_string.c_str(), 1024);
// Report from the same location at most once every 30 days (unless the
// process has died). This attempts to prevent us from flooding ourselves with
// repeat reports for the same bug.
base::debug::DumpWithoutCrashing(location, base::Days(30));
#if !BUILDFLAG(IS_NACL)
base::debug::ClearCrashKeyString(GetFatalMilestoneCrashKey());
#endif // !BUILDFLAG(IS_NACL)
}
void HandleCheckErrorLogMessage(base::debug::CrashKeyString* message_key,
const logging::LogMessage* log_message,
const base::Location& location,
base::NotFatalUntil fatal_milestone) {
if (log_message->severity() == logging::LOGGING_FATAL) {
// Set NotFatalUntil key if applicable for when we die in ~LogMessage.
MaybeSetFatalMilestoneCrashKey(fatal_milestone);
} else {
DumpWithoutCrashing(message_key, log_message, location, fatal_milestone);
}
}
class NotReachedLogMessage : public LogMessage {
public:
NotReachedLogMessage(const base::Location& location,
LogSeverity severity,
base::NotFatalUntil fatal_milestone)
: LogMessage(location.file_name(), location.line_number(), severity),
location_(location),
fatal_milestone_(fatal_milestone) {}
~NotReachedLogMessage() override {
HandleCheckErrorLogMessage(GetNotReachedCrashKey(), this, location_,
fatal_milestone_);
}
private:
const base::Location location_;
const base::NotFatalUntil fatal_milestone_;
};
class DCheckLogMessage : public LogMessage {
public:
DCheckLogMessage(const base::Location& location)
: LogMessage(location.file_name(),
location.line_number(),
LOGGING_DCHECK),
location_(location) {}
~DCheckLogMessage() override {
HandleCheckErrorLogMessage(
GetDCheckCrashKey(), this, location_,
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
}
private:
const base::Location location_;
};
class CheckLogMessage : public LogMessage {
public:
CheckLogMessage(const base::Location& location,
LogSeverity severity,
base::NotFatalUntil fatal_milestone)
: LogMessage(location.file_name(), location.line_number(), severity),
location_(location),
fatal_milestone_(fatal_milestone) {}
~CheckLogMessage() override {
HandleCheckErrorLogMessage(GetDumpWillBeCheckCrashKey(), this, location_,
fatal_milestone_);
}
private:
const base::Location location_;
const base::NotFatalUntil fatal_milestone_;
};
#if BUILDFLAG(IS_WIN)
class DCheckWin32ErrorLogMessage : public Win32ErrorLogMessage {
public:
DCheckWin32ErrorLogMessage(const base::Location& location,
SystemErrorCode err)
: Win32ErrorLogMessage(location.file_name(),
location.line_number(),
LOGGING_DCHECK,
err),
location_(location) {}
~DCheckWin32ErrorLogMessage() override {
HandleCheckErrorLogMessage(
GetDCheckCrashKey(), this, location_,
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
}
private:
const base::Location location_;
};
#elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
class DCheckErrnoLogMessage : public ErrnoLogMessage {
public:
DCheckErrnoLogMessage(const base::Location& location, SystemErrorCode err)
: ErrnoLogMessage(location.file_name(),
location.line_number(),
LOGGING_DCHECK,
err),
location_(location) {}
~DCheckErrnoLogMessage() override {
HandleCheckErrorLogMessage(
GetDCheckCrashKey(), this, location_,
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
}
private:
const base::Location location_;
};
#endif // BUILDFLAG(IS_WIN)
} // namespace
CheckError CheckError::Check(const char* condition,
base::NotFatalUntil fatal_milestone,
const base::Location& location) {
auto* const log_message = new CheckLogMessage(
location, GetCheckSeverity(fatal_milestone), fatal_milestone);
log_message->stream() << "Check failed: " << condition << ". ";
return CheckError(log_message);
}
CheckError CheckError::CheckOp(char* log_message_str,
base::NotFatalUntil fatal_milestone,
const base::Location& location) {
auto* const log_message = new CheckLogMessage(
location, GetCheckSeverity(fatal_milestone), fatal_milestone);
log_message->stream() << log_message_str;
free(log_message_str);
return CheckError(log_message);
}
CheckError CheckError::DCheck(const char* condition,
const base::Location& location) {
auto* const log_message = new DCheckLogMessage(location);
log_message->stream() << "Check failed: " << condition << ". ";
return CheckError(log_message);
}
CheckError CheckError::DCheckOp(char* log_message_str,
const base::Location& location) {
auto* const log_message = new DCheckLogMessage(location);
log_message->stream() << log_message_str;
free(log_message_str);
return CheckError(log_message);
}
CheckError CheckError::DumpWillBeCheck(const char* condition,
const base::Location& location) {
auto* const log_message =
new CheckLogMessage(location, GetDumpSeverity(),
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
log_message->stream() << "Check failed: " << condition << ". ";
return CheckError(log_message);
}
CheckError CheckError::DumpWillBeCheckOp(char* log_message_str,
const base::Location& location) {
auto* const log_message =
new CheckLogMessage(location, GetDumpSeverity(),
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
log_message->stream() << log_message_str;
free(log_message_str);
return CheckError(log_message);
}
CheckError CheckError::DPCheck(const char* condition,
const base::Location& location) {
SystemErrorCode err_code = logging::GetLastSystemErrorCode();
#if BUILDFLAG(IS_WIN)
auto* const log_message = new DCheckWin32ErrorLogMessage(location, err_code);
#elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
auto* const log_message = new DCheckErrnoLogMessage(location, err_code);
#endif
log_message->stream() << "Check failed: " << condition << ". ";
return CheckError(log_message);
}
CheckError CheckError::NotImplemented(const char* function,
const base::Location& location) {
auto* const log_message = new LogMessage(
location.file_name(), location.line_number(), LOGGING_ERROR);
log_message->stream() << "Not implemented reached in " << function;
return CheckError(log_message);
}
std::ostream& CheckError::stream() {
return log_message_->stream();
}
CheckError::~CheckError() {
// TODO(crbug.com/40254046): Consider splitting out CHECK from DCHECK so that
// the destructor can be marked [[noreturn]] and we don't need to check
// severity in the destructor.
const bool is_fatal = log_message_->severity() == LOGGING_FATAL;
// Note: This function ends up in crash stack traces. If its full name
// changes, the crash server's magic signature logic needs to be updated.
// See cl/306632920.
// Reset before `ImmediateCrash()` to ensure the message is flushed.
log_message_.reset();
// Make sure we crash even if LOG(FATAL) has been overridden.
// TODO(crbug.com/40254046): Remove severity checking in the destructor when
// LOG(FATAL) is [[noreturn]] and can't be overridden.
if (is_fatal) {
base::ImmediateCrash();
}
}
CheckError::CheckError(LogMessage* log_message) : log_message_(log_message) {}
// Note: This function ends up in crash stack traces. If its full name changes,
// the crash server's magic signature logic needs to be updated. See
// cl/306632920.
CheckNoreturnError::~CheckNoreturnError() {
// Reset before `ImmediateCrash()` to ensure the message is flushed.
log_message_.reset();
// Make sure we die if we haven't.
// TODO(crbug.com/40254046): Replace this with NOTREACHED() once LOG(FATAL) is
// [[noreturn]].
base::ImmediateCrash();
}
CheckNoreturnError CheckNoreturnError::Check(const char* condition,
const base::Location& location) {
auto* const log_message =
new CheckLogMessage(location, LOGGING_FATAL,
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
log_message->stream() << "Check failed: " << condition << ". ";
return CheckNoreturnError(log_message);
}
CheckNoreturnError CheckNoreturnError::CheckOp(char* log_message_str,
const base::Location& location) {
auto* const log_message =
new CheckLogMessage(location, LOGGING_FATAL,
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
log_message->stream() << log_message_str;
free(log_message_str);
return CheckNoreturnError(log_message);
}
CheckNoreturnError CheckNoreturnError::PCheck(const char* condition,
const base::Location& location) {
SystemErrorCode err_code = logging::GetLastSystemErrorCode();
#if BUILDFLAG(IS_WIN)
auto* const log_message = new Win32ErrorLogMessage(
location.file_name(), location.line_number(), LOGGING_FATAL, err_code);
#elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
auto* const log_message = new ErrnoLogMessage(
location.file_name(), location.line_number(), LOGGING_FATAL, err_code);
#endif
log_message->stream() << "Check failed: " << condition << ". ";
return CheckNoreturnError(log_message);
}
CheckNoreturnError CheckNoreturnError::PCheck(const base::Location& location) {
return PCheck("", location);
}
NotReachedError NotReachedError::NotReached(base::NotFatalUntil fatal_milestone,
const base::Location& location) {
auto* const log_message = new NotReachedLogMessage(
location, GetCheckSeverity(fatal_milestone), fatal_milestone);
// TODO(pbos): Consider a better message for NotReached(), this is here to
// match existing behavior + test expectations.
log_message->stream() << "Check failed: false. ";
return NotReachedError(log_message);
}
NotReachedError NotReachedError::DumpWillBeNotReached(
const base::Location& location) {
auto* const log_message = new NotReachedLogMessage(
location, GetDumpSeverity(),
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
log_message->stream() << "NOTREACHED hit. ";
return NotReachedError(log_message);
}
NotReachedError::~NotReachedError() = default;
NotReachedNoreturnError::NotReachedNoreturnError(const base::Location& location)
: CheckError([location] {
auto* const log_message = new NotReachedLogMessage(
location, LOGGING_FATAL,
base::NotFatalUntil::NoSpecifiedMilestoneInternal);
log_message->stream() << "NOTREACHED hit. ";
return log_message;
}()) {}
// Note: This function ends up in crash stack traces. If its full name changes,
// the crash server's magic signature logic needs to be updated. See
// cl/306632920.
NotReachedNoreturnError::~NotReachedNoreturnError() {
// Reset before `ImmediateCrash()` to ensure the message is flushed.
log_message_.reset();
// Make sure we die if we haven't.
// TODO(crbug.com/40254046): Replace this with NOTREACHED() once LOG(FATAL) is
// [[noreturn]].
base::ImmediateCrash();
}
void RawCheckFailure(const char* message) {
RawLog(LOGGING_FATAL, message);
__builtin_unreachable();
}
} // namespace logging