absl/log/absl_check.h

0001 // Copyright 2022 The Abseil Authors.
0002 //
0003 // Licensed under the Apache License, Version 2.0 (the "License");
0004 // you may not use this file except in compliance with the License.
0005 // You may obtain a copy of the License at
0006 //
0007 //      https://www.apache.org/licenses/LICENSE-2.0
0008 //
0009 // Unless required by applicable law or agreed to in writing, software
0010 // distributed under the License is distributed on an "AS IS" BASIS,
0011 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0012 // See the License for the specific language governing permissions and
0013 // limitations under the License.
0014 //
0015 // -----------------------------------------------------------------------------
0016 // File: log/absl_check.h
0017 // -----------------------------------------------------------------------------
0018 //
0019 // This header declares a family of `ABSL_CHECK` macros as alternative spellings
0020 // for `CHECK` macros in `check.h`.
0021 //
0022 // Except for those whose names begin with `ABSL_DCHECK`, these macros are not
0023 // controlled by `NDEBUG` (cf. `assert`), so the check will be executed
0024 // regardless of compilation mode. `ABSL_CHECK` and friends are thus useful for
0025 // confirming invariants in situations where continuing to run would be worse
0026 // than terminating, e.g., due to risk of data corruption or security
0027 // compromise.  It is also more robust and portable to deliberately terminate
0028 // at a particular place with a useful message and backtrace than to assume some
0029 // ultimately unspecified and unreliable crashing behavior (such as a
0030 // "segmentation fault").
0031 //
0032 // For full documentation of each macro, see comments in `check.h`, which has an
0033 // identical set of macros without the ABSL_* prefix.
0034
0035 #ifndef ABSL_LOG_ABSL_CHECK_H_
0036 #define ABSL_LOG_ABSL_CHECK_H_
0037
0038 #include "absl/log/internal/check_impl.h"
0039
0040 #define ABSL_CHECK(condition) \
0041   ABSL_LOG_INTERNAL_CHECK_IMPL((condition), #condition)
0042 #define ABSL_QCHECK(condition) \
0043   ABSL_LOG_INTERNAL_QCHECK_IMPL((condition), #condition)
0044 #define ABSL_PCHECK(condition) \
0045   ABSL_LOG_INTERNAL_PCHECK_IMPL((condition), #condition)
0046 #define ABSL_DCHECK(condition) \
0047   ABSL_LOG_INTERNAL_DCHECK_IMPL((condition), #condition)
0048
0049 #define ABSL_CHECK_EQ(val1, val2) \
0050   ABSL_LOG_INTERNAL_CHECK_EQ_IMPL((val1), #val1, (val2), #val2)
0051 #define ABSL_CHECK_NE(val1, val2) \
0052   ABSL_LOG_INTERNAL_CHECK_NE_IMPL((val1), #val1, (val2), #val2)
0053 #define ABSL_CHECK_LE(val1, val2) \
0054   ABSL_LOG_INTERNAL_CHECK_LE_IMPL((val1), #val1, (val2), #val2)
0055 #define ABSL_CHECK_LT(val1, val2) \
0056   ABSL_LOG_INTERNAL_CHECK_LT_IMPL((val1), #val1, (val2), #val2)
0057 #define ABSL_CHECK_GE(val1, val2) \
0058   ABSL_LOG_INTERNAL_CHECK_GE_IMPL((val1), #val1, (val2), #val2)
0059 #define ABSL_CHECK_GT(val1, val2) \
0060   ABSL_LOG_INTERNAL_CHECK_GT_IMPL((val1), #val1, (val2), #val2)
0061 #define ABSL_QCHECK_EQ(val1, val2) \
0062   ABSL_LOG_INTERNAL_QCHECK_EQ_IMPL((val1), #val1, (val2), #val2)
0063 #define ABSL_QCHECK_NE(val1, val2) \
0064   ABSL_LOG_INTERNAL_QCHECK_NE_IMPL((val1), #val1, (val2), #val2)
0065 #define ABSL_QCHECK_LE(val1, val2) \
0066   ABSL_LOG_INTERNAL_QCHECK_LE_IMPL((val1), #val1, (val2), #val2)
0067 #define ABSL_QCHECK_LT(val1, val2) \
0068   ABSL_LOG_INTERNAL_QCHECK_LT_IMPL((val1), #val1, (val2), #val2)
0069 #define ABSL_QCHECK_GE(val1, val2) \
0070   ABSL_LOG_INTERNAL_QCHECK_GE_IMPL((val1), #val1, (val2), #val2)
0071 #define ABSL_QCHECK_GT(val1, val2) \
0072   ABSL_LOG_INTERNAL_QCHECK_GT_IMPL((val1), #val1, (val2), #val2)
0073 #define ABSL_DCHECK_EQ(val1, val2) \
0074   ABSL_LOG_INTERNAL_DCHECK_EQ_IMPL((val1), #val1, (val2), #val2)
0075 #define ABSL_DCHECK_NE(val1, val2) \
0076   ABSL_LOG_INTERNAL_DCHECK_NE_IMPL((val1), #val1, (val2), #val2)
0077 #define ABSL_DCHECK_LE(val1, val2) \
0078   ABSL_LOG_INTERNAL_DCHECK_LE_IMPL((val1), #val1, (val2), #val2)
0079 #define ABSL_DCHECK_LT(val1, val2) \
0080   ABSL_LOG_INTERNAL_DCHECK_LT_IMPL((val1), #val1, (val2), #val2)
0081 #define ABSL_DCHECK_GE(val1, val2) \
0082   ABSL_LOG_INTERNAL_DCHECK_GE_IMPL((val1), #val1, (val2), #val2)
0083 #define ABSL_DCHECK_GT(val1, val2) \
0084   ABSL_LOG_INTERNAL_DCHECK_GT_IMPL((val1), #val1, (val2), #val2)
0085
0086 #define ABSL_CHECK_OK(status) ABSL_LOG_INTERNAL_CHECK_OK_IMPL((status), #status)
0087 #define ABSL_QCHECK_OK(status) \
0088   ABSL_LOG_INTERNAL_QCHECK_OK_IMPL((status), #status)
0089 #define ABSL_DCHECK_OK(status) \
0090   ABSL_LOG_INTERNAL_DCHECK_OK_IMPL((status), #status)
0091
0092 #define ABSL_CHECK_STREQ(s1, s2) \
0093   ABSL_LOG_INTERNAL_CHECK_STREQ_IMPL((s1), #s1, (s2), #s2)
0094 #define ABSL_CHECK_STRNE(s1, s2) \
0095   ABSL_LOG_INTERNAL_CHECK_STRNE_IMPL((s1), #s1, (s2), #s2)
0096 #define ABSL_CHECK_STRCASEEQ(s1, s2) \
0097   ABSL_LOG_INTERNAL_CHECK_STRCASEEQ_IMPL((s1), #s1, (s2), #s2)
0098 #define ABSL_CHECK_STRCASENE(s1, s2) \
0099   ABSL_LOG_INTERNAL_CHECK_STRCASENE_IMPL((s1), #s1, (s2), #s2)
0100 #define ABSL_QCHECK_STREQ(s1, s2) \
0101   ABSL_LOG_INTERNAL_QCHECK_STREQ_IMPL((s1), #s1, (s2), #s2)
0102 #define ABSL_QCHECK_STRNE(s1, s2) \
0103   ABSL_LOG_INTERNAL_QCHECK_STRNE_IMPL((s1), #s1, (s2), #s2)
0104 #define ABSL_QCHECK_STRCASEEQ(s1, s2) \
0105   ABSL_LOG_INTERNAL_QCHECK_STRCASEEQ_IMPL((s1), #s1, (s2), #s2)
0106 #define ABSL_QCHECK_STRCASENE(s1, s2) \
0107   ABSL_LOG_INTERNAL_QCHECK_STRCASENE_IMPL((s1), #s1, (s2), #s2)
0108 #define ABSL_DCHECK_STREQ(s1, s2) \
0109   ABSL_LOG_INTERNAL_DCHECK_STREQ_IMPL((s1), #s1, (s2), #s2)
0110 #define ABSL_DCHECK_STRNE(s1, s2) \
0111   ABSL_LOG_INTERNAL_DCHECK_STRNE_IMPL((s1), #s1, (s2), #s2)
0112 #define ABSL_DCHECK_STRCASEEQ(s1, s2) \
0113   ABSL_LOG_INTERNAL_DCHECK_STRCASEEQ_IMPL((s1), #s1, (s2), #s2)
0114 #define ABSL_DCHECK_STRCASENE(s1, s2) \
0115   ABSL_LOG_INTERNAL_DCHECK_STRCASENE_IMPL((s1), #s1, (s2), #s2)
0116
0117 #endif  // ABSL_LOG_ABSL_CHECK_H_