1 //===- llvm/Support/ErrorOr.h - Error Smart Pointer -----------------------===//
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 /// Provides ErrorOr<T> smart pointer.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_SUPPORT_ERROR_OR_H
17 #define LLVM_SUPPORT_ERROR_OR_H
19 #include "llvm/ADT/PointerIntPair.h"
20 #include "llvm/Support/AlignOf.h"
21 #include "llvm/Support/system_error.h"
22 #include "llvm/Support/type_traits.h"
25 #if LLVM_HAS_CXX11_TYPETRAITS
26 #include <type_traits>
30 struct ErrorHolderBase {
35 ErrorHolderBase() : RefCount(1) {}
47 virtual ~ErrorHolderBase() {}
51 struct ErrorHolder : ErrorHolderBase {
52 #if LLVM_HAS_RVALUE_REFERENCES
53 ErrorHolder(T &&UD) : UserData(llvm_move(UD)) {}
55 ErrorHolder(T &UD) : UserData(UD) {}
60 template<class Tp> struct ErrorOrUserDataTraits : llvm::false_type {};
62 #if LLVM_HAS_CXX11_TYPETRAITS && LLVM_HAS_RVALUE_REFERENCES
63 template<class T, class V>
64 typename std::enable_if< std::is_constructible<T, V>::value
65 , typename std::remove_reference<V>::type>::type &&
66 moveIfMoveConstructible(V &Val) {
67 return std::move(Val);
70 template<class T, class V>
71 typename std::enable_if< !std::is_constructible<T, V>::value
72 , typename std::remove_reference<V>::type>::type &
73 moveIfMoveConstructible(V &Val) {
77 template<class T, class V>
78 V &moveIfMoveConstructible(V &Val) {
83 /// \brief Stores a reference that can be changed.
85 class ReferenceStorage {
89 ReferenceStorage(T &Ref) : Storage(&Ref) {}
91 operator T &() const { return *Storage; }
92 T &get() const { return *Storage; }
95 /// \brief Represents either an error or a value T.
97 /// ErrorOr<T> is a pointer-like class that represents the result of an
98 /// operation. The result is either an error, or a value of type T. This is
99 /// designed to emulate the usage of returning a pointer where nullptr indicates
100 /// failure. However instead of just knowing that the operation failed, we also
101 /// have an error_code and optional user data that describes why it failed.
103 /// It is used like the following.
105 /// ErrorOr<Buffer> getBuffer();
106 /// void handleError(error_code ec);
108 /// auto buffer = getBuffer();
110 /// handleError(buffer);
111 /// buffer->write("adena");
114 /// ErrorOr<T> also supports user defined data for specific error_codes. To use
115 /// this feature you must first add a template specialization of
116 /// ErrorOrUserDataTraits derived from std::true_type for your type in the lld
117 /// namespace. This specialization must have a static error_code error()
118 /// function that returns the error_code this data is used with.
120 /// getError<UserData>() may be called to get either the stored user data, or
121 /// a default constructed UserData if none was stored.
125 /// struct InvalidArgError {
126 /// InvalidArgError() {}
127 /// InvalidArgError(std::string S) : ArgName(S) {}
128 /// std::string ArgName;
133 /// struct ErrorOrUserDataTraits<InvalidArgError> : std::true_type {
134 /// static error_code error() {
135 /// return make_error_code(errc::invalid_argument);
138 /// } // end namespace llvm
140 /// using namespace llvm;
142 /// ErrorOr<int> foo() {
143 /// return InvalidArgError("adena");
148 /// if (!a && error_code(a) == errc::invalid_argument)
149 /// llvm::errs() << a.getError<InvalidArgError>().ArgName << "\n";
153 /// An implicit conversion to bool provides a way to check if there was an
154 /// error. The unary * and -> operators provide pointer like access to the
155 /// value. Accessing the value when there is an error has undefined behavior.
157 /// When T is a reference type the behaivor is slightly different. The reference
158 /// is held in a std::reference_wrapper<std::remove_reference<T>::type>, and
159 /// there is special handling to make operator -> work as if T was not a
162 /// T cannot be a rvalue reference.
165 static const bool isRef = is_reference<T>::value;
166 typedef ReferenceStorage<typename remove_reference<T>::type> wrap;
173 >::type storage_type;
176 typedef typename remove_reference<T>::type &reference;
177 typedef typename remove_reference<T>::type *pointer;
180 ErrorOr() : IsValid(false) {}
182 ErrorOr(llvm::error_code EC) : HasError(true), IsValid(true) {
183 Error = new ErrorHolderBase;
185 Error->HasUserData = false;
188 template<class UserDataT>
189 ErrorOr(UserDataT UD, typename
190 enable_if_c<ErrorOrUserDataTraits<UserDataT>::value>::type* = 0)
191 : HasError(true), IsValid(true) {
192 Error = new ErrorHolder<UserDataT>(llvm_move(UD));
193 Error->Error = ErrorOrUserDataTraits<UserDataT>::error();
194 Error->HasUserData = true;
197 ErrorOr(T Val) : HasError(false), IsValid(true) {
198 new (get()) storage_type(moveIfMoveConstructible<storage_type>(Val));
201 ErrorOr(const ErrorOr &Other) : IsValid(false) {
202 // Construct an invalid ErrorOr if other is invalid.
205 if (!Other.HasError) {
206 // Get the other value.
207 new (get()) storage_type(*Other.get());
210 // Get other's error.
219 ErrorOr &operator =(const ErrorOr &Other) {
224 new (this) ErrorOr(Other);
229 #if LLVM_HAS_RVALUE_REFERENCES
230 ErrorOr(ErrorOr &&Other) : IsValid(false) {
231 // Construct an invalid ErrorOr if other is invalid.
234 if (!Other.HasError) {
235 // Get the other value.
237 new (get()) storage_type(std::move(*Other.get()));
239 // Tell other not to do any destruction.
240 Other.IsValid = false;
242 // Get other's error.
245 // Tell other not to do any destruction.
246 Other.IsValid = false;
252 ErrorOr &operator =(ErrorOr &&Other) {
257 new (this) ErrorOr(std::move(Other));
269 get()->~storage_type();
273 ET getError() const {
274 assert(IsValid && "Cannot get the error of a default constructed ErrorOr!");
275 assert(HasError && "Cannot get an error if none exists!");
276 assert(ErrorOrUserDataTraits<ET>::error() == Error->Error &&
277 "Incorrect user error data type for error!");
278 if (!Error->HasUserData)
280 return reinterpret_cast<const ErrorHolder<ET>*>(Error)->UserData;
283 typedef void (*unspecified_bool_type)();
284 static void unspecified_bool_true() {}
286 /// \brief Return false if there is an error.
287 operator unspecified_bool_type() const {
288 assert(IsValid && "Can't do anything on a default constructed ErrorOr!");
289 return HasError ? 0 : unspecified_bool_true;
292 operator llvm::error_code() const {
293 assert(IsValid && "Can't do anything on a default constructed ErrorOr!");
294 return HasError ? Error->Error : llvm::error_code::success();
297 pointer operator ->() {
298 return toPointer(get());
301 reference operator *() {
306 pointer toPointer(pointer Val) {
310 pointer toPointer(wrap *Val) {
315 storage_type *get() {
316 assert(IsValid && "Can't do anything on a default constructed ErrorOr!");
317 assert(!HasError && "Cannot get value when an error exists!");
318 return reinterpret_cast<storage_type*>(TStorage.buffer);
321 const storage_type *get() const {
322 assert(IsValid && "Can't do anything on a default constructed ErrorOr!");
323 assert(!HasError && "Cannot get value when an error exists!");
324 return reinterpret_cast<const storage_type*>(TStorage.buffer);
328 AlignedCharArrayUnion<storage_type> TStorage;
329 ErrorHolderBase *Error;
335 // ErrorOr specialization for void.
337 class ErrorOr<void> {
339 ErrorOr() : Error(nullptr, 0) {}
341 ErrorOr(llvm::error_code EC) : Error(nullptr, 0) {
342 if (EC == errc::success) {
346 ErrorHolderBase *E = new ErrorHolderBase;
348 E->HasUserData = false;
352 template<class UserDataT>
353 ErrorOr(UserDataT UD, typename
354 enable_if_c<ErrorOrUserDataTraits<UserDataT>::value>::type* = 0)
355 : Error(nullptr, 0) {
356 ErrorHolderBase *E = new ErrorHolder<UserDataT>(llvm_move(UD));
357 E->Error = ErrorOrUserDataTraits<UserDataT>::error();
358 E->HasUserData = true;
362 ErrorOr(const ErrorOr &Other) : Error(nullptr, 0) {
364 if (Other.Error.getPointer()->Error) {
365 Error.getPointer()->aquire();
369 ErrorOr &operator =(const ErrorOr &Other) {
374 new (this) ErrorOr(Other);
379 #if LLVM_HAS_RVALUE_REFERENCES
380 ErrorOr(ErrorOr &&Other) : Error(nullptr) {
381 // Get other's error.
383 // Tell other not to do any destruction.
384 Other.Error.setPointer(nullptr);
387 ErrorOr &operator =(ErrorOr &&Other) {
392 new (this) ErrorOr(std::move(Other));
399 if (Error.getPointer())
400 Error.getPointer()->release();
404 ET getError() const {
405 assert(ErrorOrUserDataTraits<ET>::error() == *this &&
406 "Incorrect user error data type for error!");
407 if (!Error.getPointer()->HasUserData)
409 return reinterpret_cast<const ErrorHolder<ET> *>(
410 Error.getPointer())->UserData;
413 typedef void (*unspecified_bool_type)();
414 static void unspecified_bool_true() {}
416 /// \brief Return false if there is an error.
417 operator unspecified_bool_type() const {
418 return Error.getInt() ? unspecified_bool_true : 0;
421 operator llvm::error_code() const {
422 return Error.getInt() ? make_error_code(errc::success)
423 : Error.getPointer()->Error;
427 // If the bit is 1, the error is success.
428 llvm::PointerIntPair<ErrorHolderBase *, 1> Error;
431 template<class T, class E>
432 typename enable_if_c<is_error_code_enum<E>::value ||
433 is_error_condition_enum<E>::value, bool>::type
434 operator ==(ErrorOr<T> &Err, E Code) {
435 return error_code(Err) == Code;
437 } // end namespace llvm