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
|
/**
* 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 <cstdint>
#include <iosfwd>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/platform/compiler.h"
namespace mongo {
class Status;
// ErrorExtraInfo subclasses:
//#for $ec in $codes:
//#if $ec.extra
class $ec.extra;
//#end if
//#end for
enum class ErrorCategory {
//#for $cat in $categories
${cat.name},
//#end for
};
/**
* This is a generated class containing a table of error codes and their corresponding error
* strings. The class is derived from the definitions in src/mongo/base/error_codes.err file and the
* src/mongo/base/error_codes.tpl.h template.
*
* Do not update this file directly. Update src/mongo/base/error_codes.err instead.
*/
class ErrorCodes {
public:
// Explicitly 32-bits wide so that non-symbolic values,
// like uassert codes, are valid.
enum Error : std::int32_t {
//#for $ec in $codes
$ec.name = $ec.code,
//#end for
MaxError
};
static std::string errorString(Error err);
/**
* Parses an Error from its "name". Returns UnknownError if "name" is unrecognized.
*
* NOTE: Also returns UnknownError for the string "UnknownError".
*/
static Error fromString(StringData name);
/**
* Reuses a unique numeric code in a way that supresses the duplicate code detection. This
* should only be used when testing error cases to ensure that the code under test fails in the
* right place. It should NOT be used in non-test code to either make a new error site (use
* ErrorCodes::Error(CODE) for that) or to see if a specific failure case occurred (use named
* codes for that).
*/
static Error duplicateCodeForTest(int code) {
return static_cast<Error>(code);
}
/**
* Generic predicate to test if a given error code is in a category.
*
* This version is intended to simplify forwarding by Status and DBException. Non-generic
* callers should just use the specific isCategoryName() methods instead.
*/
template <ErrorCategory category>
static bool isA(Error code);
//#for $cat in $categories
static bool is${cat.name}(Error code);
//#end for
static bool shouldHaveExtraInfo(Error code);
};
std::ostream& operator<<(std::ostream& stream, ErrorCodes::Error code);
//#for $cat in $categories
template <>
inline bool ErrorCodes::isA<ErrorCategory::$cat.name>(Error code) {
return is${cat.name}(code);
}
//#end for
/**
* This namespace contains implementation details for our error handling code and should not be used
* directly in general code.
*/
namespace error_details {
template <int32_t code>
constexpr bool isNamedCode = false;
//#for $ec in $codes
template <>
constexpr bool isNamedCode<ErrorCodes::$ec.name> = true;
//#end for
MONGO_COMPILER_NORETURN void throwExceptionForStatus(const Status& status);
//
// ErrorCategoriesFor
//
template <ErrorCategory... categories>
struct CategoryList;
template <ErrorCodes::Error code>
struct ErrorCategoriesForImpl {
using type = CategoryList<>;
};
//#for $ec in $codes:
//#if $ec.categories
template <>
struct ErrorCategoriesForImpl<ErrorCodes::$ec.name> {
using type = CategoryList<
//#for $i, $cat in enumerate($ec.categories)
//#set $comma = '' if i == len($ec.categories) - 1 else ', '
ErrorCategory::$cat$comma
//#end for
>;
};
//#end if
//#end for
template <ErrorCodes::Error code>
using ErrorCategoriesFor = typename ErrorCategoriesForImpl<code>::type;
//
// ErrorExtraInfoFor
//
template <ErrorCodes::Error code>
struct ErrorExtraInfoForImpl {};
//#for $code in $codes
//#if $code.extra
template <>
struct ErrorExtraInfoForImpl<ErrorCodes::$code.name> {
using type = $code.extra;
};
//#end if
//#end for
template <ErrorCodes::Error code>
using ErrorExtraInfoFor = typename ErrorExtraInfoForImpl<code>::type;
} // namespace error_details
} // namespace mongo
|
