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
|
/**
* 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.
*/
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kControl
#include "mongo/base/status.h"
#include "mongo/db/jsobj.h"
#include "mongo/logv2/log.h"
#include "mongo/util/str.h"
#include <ostream>
#include <sstream>
namespace mongo {
Status::ErrorInfo::ErrorInfo(ErrorCodes::Error code,
StringData reason,
std::shared_ptr<const ErrorExtraInfo> extra)
: code(code), reason(reason.toString()), extra(std::move(extra)) {}
Status::ErrorInfo* Status::ErrorInfo::create(ErrorCodes::Error code,
StringData reason,
std::shared_ptr<const ErrorExtraInfo> extra) {
if (code == ErrorCodes::OK)
return nullptr;
if (extra) {
// The public API prevents getting in to this state.
invariant(ErrorCodes::canHaveExtraInfo(code));
} else if (ErrorCodes::mustHaveExtraInfo(code)) {
// If an ErrorExtraInfo class is non-optional, return an error.
// This is possible if code calls a 2-argument Status constructor with a code that should
// have extra info.
if (kDebugBuild) {
// Make it easier to find this issue by fatally failing in debug builds.
LOGV2_FATAL(40680, "Code {code} is supposed to have extra info", "code"_attr = code);
}
// In release builds, replace the error code. This maintains the invariant that all Statuses
// for a code that is supposed to hold extra info hold correctly-typed extra info, without
// crashing the server.
return new ErrorInfo{ErrorCodes::Error(40671),
str::stream() << "Missing required extra info for error code " << code,
std::move(extra)};
}
return new ErrorInfo{code, reason, std::move(extra)};
}
Status::Status(ErrorCodes::Error code,
StringData reason,
std::shared_ptr<const ErrorExtraInfo> extra)
: _error(ErrorInfo::create(code, reason, std::move(extra))) {
ref(_error);
}
Status::Status(ErrorCodes::Error code, const std::string& reason) : Status(code, reason, nullptr) {}
Status::Status(ErrorCodes::Error code, const char* reason)
: Status(code, StringData(reason), nullptr) {}
Status::Status(ErrorCodes::Error code, StringData reason) : Status(code, reason, nullptr) {}
Status::Status(ErrorCodes::Error code, StringData reason, const BSONObj& extraInfoHolder)
: Status(OK()) {
if (auto parser = ErrorExtraInfo::parserFor(code)) {
try {
*this = Status(code, reason, parser(extraInfoHolder));
} catch (const DBException& ex) {
*this = ex.toStatus(str::stream() << "Error parsing extra info for " << code);
}
} else {
*this = Status(code, reason);
}
}
Status::Status(ErrorCodes::Error code, const str::stream& reason)
: Status(code, std::string(reason)) {}
Status Status::withReason(StringData newReason) const {
return isOK() ? OK() : Status(code(), newReason, _error->extra);
}
Status Status::withContext(StringData reasonPrefix) const {
return isOK() ? OK() : withReason(reasonPrefix + causedBy(reason()));
}
std::ostream& operator<<(std::ostream& os, const Status& status) {
return os << status.codeString() << " " << status.reason();
}
template <typename Allocator>
StringBuilderImpl<Allocator>& operator<<(StringBuilderImpl<Allocator>& sb, const Status& status) {
sb << status.codeString();
if (!status.isOK()) {
try {
if (auto extra = status.extraInfo()) {
BSONObjBuilder bob;
extra->serialize(&bob);
sb << bob.obj();
}
} catch (const DBException&) {
// This really shouldn't happen but it would be really annoying if it broke error
// logging in production.
if (kDebugBuild) {
LOGV2_FATAL_CONTINUE(
23806,
"Error serializing extra info for {status_code} in Status::toString()",
"status_code"_attr = status.code());
std::terminate();
}
}
sb << ": " << status.reason();
}
return sb;
}
template StringBuilder& operator<<(StringBuilder& sb, const Status& status);
std::string Status::toString() const {
StringBuilder sb;
sb << *this;
return sb.str();
}
void Status::serialize(BSONObjBuilder* builder) const {
if (isOK()) {
builder->append("code", code());
builder->append("codeName", ErrorCodes::errorString(code()));
} else {
serializeErrorToBSON(builder);
}
}
void Status::serializeErrorToBSON(BSONObjBuilder* builder) const {
invariant(!isOK());
builder->append("code", code());
builder->append("codeName", ErrorCodes::errorString(code()));
builder->append("errmsg", reason());
if (auto ei = extraInfo())
ei->serialize(builder);
}
} // namespace mongo
|
