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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <boost/preprocessor/facilities/overload.hpp>
#include <string>
#include "mongo/platform/compiler.h"
#include "mongo/util/debug_util.h"
namespace mongo {
/**
* This include exists so that mongo/base/status_with.h can use the invariant macro without causing
* a circular include chain. It should never be included directly in any other file other than that
* one (and assert_util.h).
*/
#if !defined(MONGO_INCLUDE_INVARIANT_H_WHITELISTED)
#error "Include assert_util.h instead of invariant.h."
#endif
MONGO_COMPILER_NORETURN void invariantFailed(const char* expr,
const char* file,
unsigned line) noexcept;
// This overload is our legacy invariant, which just takes a condition to test.
//
// ex) invariant(!condition);
//
// Invariant failure !condition some/file.cpp 528
//
#define MONGO_invariant_1(Expression) \
::mongo::invariantWithLocation((Expression), #Expression, __FILE__, __LINE__)
template <typename T>
inline void invariantWithLocation(const T& testOK,
const char* expr,
const char* file,
unsigned line) {
if (MONGO_unlikely(!testOK)) {
::mongo::invariantFailed(expr, file, line);
}
}
MONGO_COMPILER_NORETURN void invariantFailedWithMsg(const char* expr,
const std::string& msg,
const char* file,
unsigned line) noexcept;
// This invariant overload accepts a condition and a message, to be logged if the condition is
// false.
//
// ex) invariant(!condition, "hello!");
//
// Invariant failure !condition "hello!" some/file.cpp 528
//
#define MONGO_invariant_2(Expression, contextExpr) \
::mongo::invariantWithContextAndLocation((Expression), \
#Expression, \
[&]() -> std::string { return (contextExpr); }, \
__FILE__, \
__LINE__)
template <typename T, typename ContextExpr>
inline void invariantWithContextAndLocation(
const T& testOK, const char* expr, ContextExpr&& contextExpr, const char* file, unsigned line) {
if (MONGO_unlikely(!testOK)) {
::mongo::invariantFailedWithMsg(expr, contextExpr(), file, line);
}
}
// This helper macro is necessary to make the __VAR_ARGS__ expansion work properly on MSVC.
#define MONGO_expand(x) x
#define invariant(...) \
MONGO_expand(MONGO_expand(BOOST_PP_OVERLOAD(MONGO_invariant_, __VA_ARGS__))(__VA_ARGS__))
// Behaves like invariant in debug builds and is compiled out in release. Use for checks, which can
// potentially be slow or on a critical path.
#define MONGO_dassert(...) \
if (kDebugBuild) \
invariant(__VA_ARGS__)
#define dassert MONGO_dassert
} // namespace mongo
|
