folly/ExceptionWrapper.h

   1 /*
   2  * Copyright 2014 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_EXCEPTIONWRAPPER_H
  18 #define FOLLY_EXCEPTIONWRAPPER_H
  19
  20 #include <cassert>
  21 #include <exception>
  22 #include <memory>
  23 #include <folly/String.h>
  24 #include <folly/detail/ExceptionWrapper.h>
  25
  26 namespace folly {
  27
  28 /*
  29  * Throwing exceptions can be a convenient way to handle errors. Storing
  30  * exceptions in an exception_ptr makes it easy to handle exceptions in a
  31  * different thread or at a later time. exception_ptr can also be used in a very
  32  * generic result/exception wrapper.
  33  *
  34  * However, there are some issues with throwing exceptions and
  35  * std::exception_ptr. These issues revolve around throw being expensive,
  36  * particularly in a multithreaded environment (see
  37  * ExceptionWrapperBenchmark.cpp).
  38  *
  39  * Imagine we have a library that has an API which returns a result/exception
  40  * wrapper. Let's consider some approaches for implementing this wrapper.
  41  * First, we could store a std::exception. This approach loses the derived
  42  * exception type, which can make exception handling more difficult for users
  43  * that prefer rethrowing the exception. We could use a folly::dynamic for every
  44  * possible type of exception. This is not very flexible - adding new types of
  45  * exceptions requires a change to the result/exception wrapper. We could use an
  46  * exception_ptr. However, constructing an exception_ptr as well as accessing
  47  * the error requires a call to throw. That means that there will be two calls
  48  * to throw in order to process the exception. For performance sensitive
  49  * applications, this may be unacceptable.
  50  *
  51  * exception_wrapper is designed to handle exception management for both
  52  * convenience and high performance use cases. make_exception_wrapper is
  53  * templated on derived type, allowing us to rethrow the exception properly for
  54  * users that prefer convenience. These explicitly named exception types can
  55  * therefore be handled without any peformance penalty.  exception_wrapper is
  56  * also flexible enough to accept any type. If a caught exception is not of an
  57  * explicitly named type, then std::exception_ptr is used to preserve the
  58  * exception state. For performance sensitive applications, the accessor methods
  59  * can test or extract a pointer to a specific exception type with very little
  60  * overhead.
  61  *
  62  * Example usage:
  63  *
  64  * exception_wrapper globalExceptionWrapper;
  65  *
  66  * // Thread1
  67  * void doSomethingCrazy() {
  68  *   int rc = doSomethingCrazyWithLameReturnCodes();
  69  *   if (rc == NAILED_IT) {
  70  *     globalExceptionWrapper = exception_wrapper();
  71  *   } else if (rc == FACE_PLANT) {
  72  *     globalExceptionWrapper = make_exception_wrapper<FacePlantException>();
  73  *   } else if (rc == FAIL_WHALE) {
  74  *     globalExceptionWrapper = make_exception_wrapper<FailWhaleException>();
  75  *   }
  76  * }
  77  *
  78  * // Thread2: Exceptions are ok!
  79  * void processResult() {
  80  *   try {
  81  *     globalExceptionWrapper.throwException();
  82  *   } catch (const FacePlantException& e) {
  83  *     LOG(ERROR) << "FACEPLANT!";
  84  *   } catch (const FailWhaleException& e) {
  85  *     LOG(ERROR) << "FAILWHALE!";
  86  *   }
  87  * }
  88  *
  89  * // Thread2: Exceptions are bad!
  90  * void processResult() {
  91  *   auto ep = globalExceptionWrapper.get();
  92  *   if (!ep.with_exception<FacePlantException>([&](
  93  *     FacePlantException& faceplant) {
  94  *       LOG(ERROR) << "FACEPLANT";
  95  *     })) {
  96  *     ep.with_exception<FailWhaleException>([&](
  97  *       FailWhaleException& failwhale) {
  98  *         LOG(ERROR) << "FAILWHALE!";
  99  *       });
 100  *   }
 101  * }
 102  *
 103  */
 104 class exception_wrapper {
 105  public:
 106   exception_wrapper() : throwfn_(nullptr) { }
 107
 108   void throwException() const {
 109     if (throwfn_) {
 110       throwfn_(item_.get());
 111     } else if (eptr_) {
 112       std::rethrow_exception(eptr_);
 113     }
 114   }
 115
 116   explicit operator bool() const {
 117     return item_ || eptr_;
 118   }
 119
 120   // This implementation is similar to std::exception_ptr's implementation
 121   // where two exception_wrappers are equal when the address in the underlying
 122   // reference field both point to the same exception object.  The reference
 123   // field remains the same when the exception_wrapper is copied or when
 124   // the exception_wrapper is "rethrown".
 125   bool operator==(const exception_wrapper& a) const {
 126     if (item_) {
 127       return a.item_ && item_.get() == a.item_.get();
 128     } else {
 129       return eptr_ == a.eptr_;
 130     }
 131   }
 132
 133   bool operator!=(const exception_wrapper& a) const {
 134     return !(*this == a);
 135   }
 136
 137   // This will return a non-nullptr only if the exception is held as a
 138   // copy.  It is the only interface which will distinguish between an
 139   // exception held this way, and by exception_ptr.  You probably
 140   // shouldn't use it at all.
 141   std::exception* getCopied() { return item_.get(); }
 142   const std::exception* getCopied() const { return item_.get(); }
 143
 144   fbstring what() const {
 145     if (item_) {
 146       return exceptionStr(*item_);
 147     } else if (eptr_) {
 148       return estr_;
 149     } else {
 150       return fbstring();
 151     }
 152   }
 153
 154   fbstring class_name() const {
 155     if (item_) {
 156       return demangle(typeid(*item_));
 157     } else if (eptr_) {
 158       return ename_;
 159     } else {
 160       return fbstring();
 161     }
 162   }
 163
 164   template <class Ex>
 165   bool is_compatible_with() const {
 166     if (item_) {
 167       return dynamic_cast<const Ex*>(item_.get());
 168     } else if (eptr_) {
 169       try {
 170         std::rethrow_exception(eptr_);
 171       } catch (std::exception& e) {
 172         return dynamic_cast<const Ex*>(&e);
 173       } catch (...) {
 174         // fall through
 175       }
 176     }
 177     return false;
 178   }
 179
 180   template <class Ex, class F>
 181   bool with_exception(F f) {
 182     return with_exception1<Ex>(f, this);
 183   }
 184
 185   template <class Ex, class F>
 186   bool with_exception(F f) const {
 187     return with_exception1<const Ex>(f, this);
 188   }
 189
 190   std::exception_ptr getExceptionPtr() const {
 191     if (eptr_) {
 192       return eptr_;
 193     }
 194
 195     try {
 196       throwException();
 197     } catch (...) {
 198       return std::current_exception();
 199     }
 200     return std::exception_ptr();
 201   }
 202
 203 protected:
 204   // Optimized case: if we know what type the exception is, we can
 205   // store a copy of the concrete type, and a helper function so we
 206   // can rethrow it.
 207   std::shared_ptr<std::exception> item_;
 208   void (*throwfn_)(std::exception*);
 209   // Fallback case: store the library wrapper, which is less efficient
 210   // but gets the job done.  Also store exceptionPtr() the name of the
 211   // exception type, so we can at least get those back out without
 212   // having to rethrow.
 213   std::exception_ptr eptr_;
 214   std::string estr_;
 215   std::string ename_;
 216
 217   template <class T, class... Args>
 218   friend exception_wrapper make_exception_wrapper(Args&&... args);
 219
 220 private:
 221   // What makes this useful is that T can be exception_wrapper* or
 222   // const exception_wrapper*, and the compiler will use the
 223   // instantiation which works with F.
 224   template <class Ex, class F, class T>
 225   static bool with_exception1(F f, T* that) {
 226     if (that->item_) {
 227       if (auto ex = dynamic_cast<Ex*>(that->item_.get())) {
 228         f(*ex);
 229         return true;
 230       }
 231     } else if (that->eptr_) {
 232       try {
 233         std::rethrow_exception(that->eptr_);
 234       } catch (std::exception& e) {
 235         if (auto ex = dynamic_cast<Ex*>(&e)) {
 236           f(*ex);
 237           return true;
 238         }
 239       } catch (...) {
 240         // fall through
 241       }
 242     }
 243     return false;
 244   }
 245 };
 246
 247 template <class T, class... Args>
 248 exception_wrapper make_exception_wrapper(Args&&... args) {
 249   exception_wrapper ew;
 250   ew.item_ = std::make_shared<T>(std::forward<Args>(args)...);
 251   ew.throwfn_ = folly::detail::Thrower<T>::doThrow;
 252   return ew;
 253 }
 254
 255 /*
 256  * try_and_catch is a simple replacement for try {} catch(){} that allows you to
 257  * specify which derived exceptions you would like to catch and store in an
 258  * exception_wrapper.
 259  *
 260  * Because we cannot build an equivalent of std::current_exception(), we need
 261  * to catch every derived exception that we are interested in catching.
 262  *
 263  * Exceptions should be listed in the reverse order that you would write your
 264  * catch statements (that is, std::exception& should be first).
 265  *
 266  * NOTE: Although implemented as a derived class (for syntactic delight), don't
 267  * be confused - you should not pass around try_and_catch objects!
 268  *
 269  * Example Usage:
 270  *
 271  * // This catches my runtime_error and if I call throwException() on ew, it
 272  * // will throw a runtime_error
 273  * auto ew = folly::try_and_catch<std::exception, std::runtime_error>([=]() {
 274  *   if (badThingHappens()) {
 275  *     throw std::runtime_error("ZOMG!");
 276  *   }
 277  * });
 278  *
 279  * // This will catch the exception and if I call throwException() on ew, it
 280  * // will throw a std::exception
 281  * auto ew = folly::try_and_catch<std::exception, std::runtime_error>([=]() {
 282  *   if (badThingHappens()) {
 283  *     throw std::exception();
 284  *   }
 285  * });
 286  *
 287  * // This will not catch the exception and it will be thrown.
 288  * auto ew = folly::try_and_catch<std::runtime_error>([=]() {
 289  *   if (badThingHappens()) {
 290  *     throw std::exception();
 291  *   }
 292  * });
 293  */
 294
 295 template <typename... Exceptions>
 296 class try_and_catch;
 297
 298 template <typename LastException, typename... Exceptions>
 299 class try_and_catch<LastException, Exceptions...> :
 300     public try_and_catch<Exceptions...> {
 301  public:
 302   template <typename F>
 303   explicit try_and_catch(F&& fn) : Base() {
 304     call_fn(fn);
 305   }
 306
 307  protected:
 308   typedef try_and_catch<Exceptions...> Base;
 309
 310   try_and_catch() : Base() {}
 311
 312   template <typename Ex>
 313   void assign_eptr(Ex& e) {
 314     this->eptr_ = std::current_exception();
 315     this->estr_ = exceptionStr(e).toStdString();
 316     this->ename_ = demangle(typeid(e)).toStdString();
 317   }
 318
 319   template <typename Ex>
 320   struct optimize {
 321     static const bool value =
 322       std::is_base_of<std::exception, Ex>::value &&
 323       std::is_copy_assignable<Ex>::value &&
 324       !std::is_abstract<Ex>::value;
 325   };
 326
 327   template <typename Ex>
 328   typename std::enable_if<!optimize<Ex>::value>::type
 329   assign_exception(Ex& e) {
 330     assign_eptr(e);
 331   }
 332
 333   template <typename Ex>
 334   typename std::enable_if<optimize<Ex>::value>::type
 335   assign_exception(Ex& e) {
 336     this->item_ = std::make_shared<Ex>(e);
 337     this->throwfn_ = folly::detail::Thrower<Ex>::doThrow;
 338   }
 339
 340   template <typename F>
 341   void call_fn(F&& fn) {
 342     try {
 343       Base::call_fn(std::move(fn));
 344     } catch (LastException& e) {
 345       if (typeid(e) == typeid(LastException&)) {
 346         assign_exception(e);
 347       } else {
 348         assign_eptr(e);
 349       }
 350     }
 351   }
 352 };
 353
 354 template<>
 355 class try_and_catch<> : public exception_wrapper {
 356  public:
 357   try_and_catch() {}
 358
 359  protected:
 360   template <typename F>
 361   void call_fn(F&& fn) {
 362     fn();
 363   }
 364 };
 365 }
 366 #endif