#ifndef FOLLY_EXCEPTIONWRAPPER_H
#define FOLLY_EXCEPTIONWRAPPER_H
+#include <cassert>
#include <exception>
#include <memory>
-#include "folly/detail/ExceptionWrapper.h"
+#include <folly/detail/ExceptionWrapper.h>
namespace folly {
+/*
+ * Throwing exceptions can be a convenient way to handle errors. Storing
+ * exceptions in an exception_ptr makes it easy to handle exceptions in a
+ * different thread or at a later time. exception_ptr can also be used in a very
+ * generic result/exception wrapper.
+ *
+ * However, there are some issues with throwing exceptions and
+ * std::exception_ptr. These issues revolve around throw being expensive,
+ * particularly in a multithreaded environment (see
+ * ExceptionWrapperBenchmark.cpp).
+ *
+ * Imagine we have a library that has an API which returns a result/exception
+ * wrapper. Let's consider some approaches for implementing this wrapper.
+ * First, we could store a std::exception. This approach loses the derived
+ * exception type, which can make exception handling more difficult for users
+ * that prefer rethrowing the exception. We could use a folly::dynamic for every
+ * possible type of exception. This is not very flexible - adding new types of
+ * exceptions requires a change to the result/exception wrapper. We could use an
+ * exception_ptr. However, constructing an exception_ptr as well as accessing
+ * the error requires a call to throw. That means that there will be two calls
+ * to throw in order to process the exception. For performance sensitive
+ * applications, this may be unacceptable.
+ *
+ * exception_wrapper is designed to handle exception management for both
+ * convenience and high performance use cases. make_exception_wrapper is
+ * templated on derived type, allowing us to rethrow the exception properly for
+ * users that prefer convenience. exception_wrapper is flexible enough to accept
+ * any std::exception. For performance sensitive applications, exception_wrapper
+ * exposes a get() function. These users can use dynamic_cast to retrieve
+ * desired derived types (hence the decision to limit usage to just
+ * std::exception instead of void*).
+ *
+ * Example usage:
+ *
+ * exception_wrapper globalExceptionWrapper;
+ *
+ * // Thread1
+ * void doSomethingCrazy() {
+ * int rc = doSomethingCrazyWithLameReturnCodes();
+ * if (rc == NAILED_IT) {
+ * globalExceptionWrapper = exception_wrapper();
+ * } else if (rc == FACE_PLANT) {
+ * globalExceptionWrapper = make_exception_wrapper<FacePlantException>();
+ * } else if (rc == FAIL_WHALE) {
+ * globalExceptionWrapper = make_exception_wrapper<FailWhaleException>();
+ * }
+ * }
+ *
+ * // Thread2: Exceptions are ok!
+ * void processResult() {
+ * try {
+ * globalExceptionWrapper.throwException();
+ * } catch (const FacePlantException& e) {
+ * LOG(ERROR) << "FACEPLANT!";
+ * } catch (const FailWhaleException& e) {
+ * LOG(ERROR) << "FAILWHALE!";
+ * }
+ * }
+ *
+ * // Thread2: Exceptions are bad!
+ * void processResult() {
+ * auto ep = globalExceptionWrapper.get();
+ * if (ep) {
+ * auto faceplant = dynamic_cast<FacePlantException*>(ep);
+ * if (faceplant) {
+ * LOG(ERROR) << "FACEPLANT";
+ * } else {
+ * auto failwhale = dynamic_cast<FailWhaleException*>(ep);
+ * if (failwhale) {
+ * LOG(ERROR) << "FAILWHALE!";
+ * }
+ * }
+ * }
+ * }
+ *
+ */
class exception_wrapper {
public:
exception_wrapper() : throwfn_(nullptr) { }
- void throwException() {
+ void throwException() const {
if (throwfn_) {
throwfn_(item_.get());
}
}
- std::exception* get() {
- return item_.get();
+ std::exception* get() { return item_.get(); }
+ const std::exception* get() const { return item_.get(); }
+
+ std::exception* operator->() { return get(); }
+ const std::exception* operator->() const { return get(); }
+
+ std::exception& operator*() { assert(get()); return *get(); }
+ const std::exception& operator*() const { assert(get()); return *get(); }
+
+ explicit operator bool() const { return get(); }
+
+ std::exception_ptr getExceptionPtr() const {
+ try {
+ throwException();
+ } catch (...) {
+ return std::current_exception();
+ }
+ return std::exception_ptr();
}
- private:
+ protected:
std::shared_ptr<std::exception> item_;
- void (*throwfn_)(void*);
+ void (*throwfn_)(std::exception*);
template <class T, class... Args>
- friend exception_wrapper make_exception_wrapper(Args... args);
+ friend exception_wrapper make_exception_wrapper(Args&&... args);
};
template <class T, class... Args>
-exception_wrapper make_exception_wrapper(Args... args) {
+exception_wrapper make_exception_wrapper(Args&&... args) {
exception_wrapper ew;
ew.item_ = std::make_shared<T>(std::forward<Args>(args)...);
- ew.throwfn_ = folly::detail::thrower<T>::doThrow;
+ ew.throwfn_ = folly::detail::Thrower<T>::doThrow;
return ew;
}
+/*
+ * try_and_catch is a simple replacement for try {} catch(){} that allows you to
+ * specify which derived exceptions you would like to catch and store in an
+ * exception_wrapper.
+ *
+ * Because we cannot build an equivalent of std::current_exception(), we need
+ * to catch every derived exception that we are interested in catching.
+ *
+ * Exceptions should be listed in the reverse order that you would write your
+ * catch statements (that is, std::exception& should be first).
+ *
+ * NOTE: Although implemented as a derived class (for syntactic delight), don't
+ * be confused - you should not pass around try_and_catch objects!
+ *
+ * Example Usage:
+ *
+ * // This catches my runtime_error and if I call throwException() on ew, it
+ * // will throw a runtime_error
+ * auto ew = folly::try_and_catch<std::exception, std::runtime_error>([=]() {
+ * if (badThingHappens()) {
+ * throw std::runtime_error("ZOMG!");
+ * }
+ * });
+ *
+ * // This will catch the exception and if I call throwException() on ew, it
+ * // will throw a std::exception
+ * auto ew = folly::try_and_catch<std::exception, std::runtime_error>([=]() {
+ * if (badThingHappens()) {
+ * throw std::exception();
+ * }
+ * });
+ *
+ * // This will not catch the exception and it will be thrown.
+ * auto ew = folly::try_and_catch<std::runtime_error>([=]() {
+ * if (badThingHappens()) {
+ * throw std::exception();
+ * }
+ * });
+ */
+
+template <typename... Exceptions>
+class try_and_catch;
+
+template <typename LastException, typename... Exceptions>
+class try_and_catch<LastException, Exceptions...> :
+ public try_and_catch<Exceptions...> {
+ public:
+ template <typename F>
+ explicit try_and_catch(F&& fn) : Base() {
+ call_fn(fn);
+ }
+
+ protected:
+ typedef try_and_catch<Exceptions...> Base;
+
+ try_and_catch() : Base() {}
+
+ template <typename F>
+ void call_fn(F&& fn) {
+ try {
+ Base::call_fn(std::move(fn));
+ } catch (const LastException& e) {
+ this->item_ = std::make_shared<LastException>(e);
+ this->throwfn_ = folly::detail::Thrower<LastException>::doThrow;
+ }
+ }
+};
+
+template<>
+class try_and_catch<> : public exception_wrapper {
+ public:
+ try_and_catch() {}
+
+ protected:
+ template <typename F>
+ void call_fn(F&& fn) {
+ fn();
+ }
+};
}
#endif
projects / folly.git / blobdiff