ui/accessibility/ax_common.h

// 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.

#ifndef UI_ACCESSIBILITY_AX_COMMON_H_
#define UI_ACCESSIBILITY_AX_COMMON_H_

#include "build/blink_buildflags.h"
#include "build/build_config.h"

#if (DCHECK_IS_ON() || !defined(OFFICIAL_BUILD)) && BUILDFLAG(USE_BLINK)
// Enable fast fails on clusterfuzz and other builds used to debug Chrome,
// in order to help narrow down illegal states more quickly.
#define AX_FAIL_FAST_BUILD() (1)
#else
#define AX_FAIL_FAST_BUILD() (0)
#endif

// SANITIZER_CHECK's use case is severe, but recoverable situations that need
// priority debugging. They trigger on Clusterfuzz, debug and sanitizer builds.
//
// TODO(pbos): Transition callers to CHECK/NOTREACHED with base::NotFatalUntil
// parameters as that provides non-fatal ways of generating bug reports with
// better diagnostics until a problem has been resolved.
#if AX_FAIL_FAST_BUILD() && !DCHECK_IS_ON()
#define SANITIZER_CHECK(val) CHECK(val)
#define SANITIZER_CHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
#define SANITIZER_CHECK_NE(val1, val2) CHECK_NE(val1, val2)
#define SANITIZER_CHECK_LE(val1, val2) CHECK_LE(val1, val2)
#define SANITIZER_CHECK_LT(val1, val2) CHECK_LT(val1, val2)
#define SANITIZER_CHECK_GE(val1, val2) CHECK_GE(val1, val2)
#define SANITIZER_CHECK_GT(val1, val2) CHECK_GT(val1, val2)
// This hack is a workaround as CHECK(false) is [[noreturn]]. A function call
// is used to trick -Wunreachable-code since SANITIZER_NOTREACHED() needs to not
// be [[noreturn]] in any build configuration.
namespace ui {
inline bool SanitizerNotreachedInternalAlwaysFalse() {
  return false;
}
}  // namespace ui
#define SANITIZER_NOTREACHED() \
  SANITIZER_CHECK(ui::SanitizerNotreachedInternalAlwaysFalse())
#else
// Fall back on an ordinary DCHECK.
#define SANITIZER_CHECK(val) DCHECK(val)
#define SANITIZER_CHECK_EQ(val1, val2) DCHECK_EQ(val1, val2)
#define SANITIZER_CHECK_NE(val1, val2) DCHECK_NE(val1, val2)
#define SANITIZER_CHECK_LE(val1, val2) DCHECK_LE(val1, val2)
#define SANITIZER_CHECK_LT(val1, val2) DCHECK_LT(val1, val2)
#define SANITIZER_CHECK_GE(val1, val2) DCHECK_GE(val1, val2)
#define SANITIZER_CHECK_GT(val1, val2) DCHECK_GT(val1, val2)
#define SANITIZER_NOTREACHED() DCHECK(false)
#endif  // AX_FAIL_FAST_BUILD() && !DCHECK_IS_ON()

#endif  // UI_ACCESSIBILITY_AX_COMMON_H_