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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
//===-- Status.cpp --------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Utility/Status.h"
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/VASPrintf.h"
#include "lldb/lldb-defines.h"
#include "lldb/lldb-enumerations.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Errno.h"
#include "llvm/Support/FormatProviders.h"
#include <cerrno>
#include <cstdarg>
#include <string>
#include <system_error>
#ifdef __APPLE__
#include <mach/mach.h>
#endif
#ifdef _WIN32
#include <windows.h>
#endif
#include <cstdint>
namespace llvm {
class raw_ostream;
}
using namespace lldb;
using namespace lldb_private;
char CloneableError::ID;
char CloneableECError::ID;
char MachKernelError::ID;
char Win32Error::ID;
namespace {
/// A std::error_code category for eErrorTypeGeneric.
class LLDBGenericCategory : public std::error_category {
const char *name() const noexcept override { return "LLDBGenericCategory"; }
std::string message(int __ev) const override { return "generic LLDB error"; };
};
LLDBGenericCategory &lldb_generic_category() {
static LLDBGenericCategory g_generic_category;
return g_generic_category;
}
} // namespace
Status::Status() : m_error(llvm::Error::success()) {}
static llvm::Error ErrorFromEnums(Status::ValueType err, ErrorType type,
std::string msg) {
switch (type) {
case eErrorTypeMachKernel:
return llvm::make_error<MachKernelError>(
std::error_code(err, std::system_category()));
case eErrorTypeWin32:
#ifdef _WIN32
if (err == NO_ERROR)
return llvm::Error::success();
#endif
return llvm::make_error<Win32Error>(
std::error_code(err, std::system_category()));
case eErrorTypePOSIX:
if (msg.empty())
return llvm::errorCodeToError(
std::error_code(err, std::generic_category()));
return llvm::createStringError(
std::move(msg), std::error_code(err, std::generic_category()));
default:
return llvm::createStringError(
std::move(msg), std::error_code(err, lldb_generic_category()));
}
}
Status::Status(ValueType err, ErrorType type, std::string msg)
: m_error(ErrorFromEnums(err, type, msg)) {}
// This logic is confusing because C++ calls the traditional (posix) errno codes
// "generic errors", while we use the term "generic" to mean completely
// arbitrary (text-based) errors.
Status::Status(std::error_code EC)
: m_error(!EC ? llvm::Error::success() : llvm::errorCodeToError(EC)) {}
Status::Status(std::string err_str)
: m_error(
llvm::createStringError(llvm::inconvertibleErrorCode(), err_str)) {}
const Status &Status::operator=(Status &&other) {
Clear();
llvm::consumeError(std::move(m_error));
m_error = std::move(other.m_error);
return *this;
}
Status Status::FromErrorStringWithFormat(const char *format, ...) {
std::string string;
va_list args;
va_start(args, format);
if (format != nullptr && format[0]) {
llvm::SmallString<1024> buf;
VASprintf(buf, format, args);
string = std::string(buf.str());
}
va_end(args);
return Status(string);
}
/// Creates a deep copy of all known errors and converts all other
/// errors to a new llvm::StringError.
static llvm::Error CloneError(const llvm::Error &error) {
llvm::Error result = llvm::Error::success();
auto clone = [](const llvm::ErrorInfoBase &e) {
if (e.isA<CloneableError>())
return llvm::Error(static_cast<const CloneableError &>(e).Clone());
if (e.isA<llvm::ECError>())
return llvm::errorCodeToError(e.convertToErrorCode());
return llvm::make_error<llvm::StringError>(e.message(),
e.convertToErrorCode(), true);
};
llvm::visitErrors(error, [&](const llvm::ErrorInfoBase &e) {
result = joinErrors(std::move(result), clone(e));
});
return result;
}
Status Status::FromError(llvm::Error error) { return Status(std::move(error)); }
llvm::Error Status::ToError() const { return CloneError(m_error); }
Status::~Status() { llvm::consumeError(std::move(m_error)); }
#ifdef _WIN32
static std::string RetrieveWin32ErrorString(uint32_t error_code) {
char *buffer = nullptr;
std::string message;
// Retrieve win32 system error.
// First, attempt to load a en-US message
if (::FormatMessageA(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_MAX_WIDTH_MASK,
NULL, error_code, MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
(LPSTR)&buffer, 0, NULL)) {
message.assign(buffer);
::LocalFree(buffer);
}
// If the previous didn't work, use the default OS language
else if (::FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER |
FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_MAX_WIDTH_MASK,
NULL, error_code, 0, (LPSTR)&buffer, 0, NULL)) {
message.assign(buffer);
::LocalFree(buffer);
}
return message;
}
#endif
std::string MachKernelError::message() const {
#if defined(__APPLE__)
if (const char *s = ::mach_error_string(convertToErrorCode().value()))
return s;
#endif
return "MachKernelError";
}
std::string Win32Error::message() const {
#if defined(_WIN32)
return RetrieveWin32ErrorString(convertToErrorCode().value());
#endif
return "Win32Error";
}
std::unique_ptr<CloneableError> MachKernelError::Clone() const {
return std::make_unique<MachKernelError>(convertToErrorCode());
}
std::unique_ptr<CloneableError> Win32Error::Clone() const {
return std::make_unique<Win32Error>(convertToErrorCode());
}
// Get the error value as a NULL C string. The error string will be fetched and
// cached on demand. The cached error string value will remain until the error
// value is changed or cleared.
const char *Status::AsCString(const char *default_error_str) const {
if (Success())
return nullptr;
m_string = llvm::toStringWithoutConsuming(m_error);
// Backwards compatibility with older implementations of Status.
if (m_error.isA<llvm::ECError>())
if (!m_string.empty() && m_string[m_string.size() - 1] == '\n')
m_string.pop_back();
if (m_string.empty()) {
if (default_error_str)
m_string.assign(default_error_str);
else
return nullptr; // User wanted a nullptr string back...
}
return m_string.c_str();
}
// Clear the error and any cached error string that it might contain.
void Status::Clear() {
if (m_error)
LLDB_LOG_ERRORV(GetLog(LLDBLog::API), std::move(m_error),
"dropping error {0}");
m_error = llvm::Error::success();
}
Status::ValueType Status::GetError() const {
Status::ValueType result = 0;
llvm::visitErrors(m_error, [&](const llvm::ErrorInfoBase &error) {
// Return the first only.
if (result)
return;
std::error_code ec = error.convertToErrorCode();
result = ec.value();
});
return result;
}
static ErrorType ErrorCodeToErrorType(std::error_code ec) {
if (ec.category() == std::generic_category())
return eErrorTypePOSIX;
if (ec.category() == lldb_generic_category() ||
ec == llvm::inconvertibleErrorCode())
return eErrorTypeGeneric;
return eErrorTypeInvalid;
}
ErrorType CloneableECError::GetErrorType() const {
return ErrorCodeToErrorType(EC);
}
lldb::ErrorType MachKernelError::GetErrorType() const {
return lldb::eErrorTypeMachKernel;
}
lldb::ErrorType Win32Error::GetErrorType() const {
return lldb::eErrorTypeWin32;
}
StructuredData::ObjectSP Status::GetAsStructuredData() const {
auto dict_up = std::make_unique<StructuredData::Dictionary>();
auto array_up = std::make_unique<StructuredData::Array>();
llvm::visitErrors(m_error, [&](const llvm::ErrorInfoBase &error) {
if (error.isA<CloneableError>())
array_up->AddItem(
static_cast<const CloneableError &>(error).GetAsStructuredData());
else
array_up->AddStringItem(error.message());
});
dict_up->AddIntegerItem("version", 1u);
dict_up->AddIntegerItem("type", (unsigned)GetType());
dict_up->AddItem("errors", std::move(array_up));
return dict_up;
}
StructuredData::ObjectSP CloneableECError::GetAsStructuredData() const {
auto dict_up = std::make_unique<StructuredData::Dictionary>();
dict_up->AddIntegerItem("version", 1u);
dict_up->AddIntegerItem("error_code", EC.value());
dict_up->AddStringItem("message", message());
return dict_up;
}
ErrorType Status::GetType() const {
ErrorType result = eErrorTypeInvalid;
llvm::visitErrors(m_error, [&](const llvm::ErrorInfoBase &error) {
// Return the first only.
if (result != eErrorTypeInvalid)
return;
if (error.isA<CloneableError>())
result = static_cast<const CloneableError &>(error).GetErrorType();
else
result = ErrorCodeToErrorType(error.convertToErrorCode());
});
return result;
}
bool Status::Fail() const {
// Note that this does not clear the checked flag in
// m_error. Otherwise we'd need to make this thread-safe.
return m_error.isA<llvm::ErrorInfoBase>();
}
Status Status::FromErrno() { return Status(llvm::errnoAsErrorCode()); }
// Returns true if the error code in this object is considered a successful
// return value.
bool Status::Success() const { return !Fail(); }
void llvm::format_provider<lldb_private::Status>::format(
const lldb_private::Status &error, llvm::raw_ostream &OS,
llvm::StringRef Options) {
llvm::format_provider<llvm::StringRef>::format(error.AsCString(), OS,
Options);
}
|