folly/ExceptionWrapper.h

   1 /*
   2  * Copyright 2016 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 #pragma once
  18
  19 #include <cassert>
  20 #include <exception>
  21 #include <memory>
  22 #include <folly/String.h>
  23 #include <folly/detail/ExceptionWrapper.h>
  24
  25 namespace folly {
  26
  27 /*
  28  * Throwing exceptions can be a convenient way to handle errors. Storing
  29  * exceptions in an exception_ptr makes it easy to handle exceptions in a
  30  * different thread or at a later time. exception_ptr can also be used in a very
  31  * generic result/exception wrapper.
  32  *
  33  * However, there are some issues with throwing exceptions and
  34  * std::exception_ptr. These issues revolve around throw being expensive,
  35  * particularly in a multithreaded environment (see
  36  * ExceptionWrapperBenchmark.cpp).
  37  *
  38  * Imagine we have a library that has an API which returns a result/exception
  39  * wrapper. Let's consider some approaches for implementing this wrapper.
  40  * First, we could store a std::exception. This approach loses the derived
  41  * exception type, which can make exception handling more difficult for users
  42  * that prefer rethrowing the exception. We could use a folly::dynamic for every
  43  * possible type of exception. This is not very flexible - adding new types of
  44  * exceptions requires a change to the result/exception wrapper. We could use an
  45  * exception_ptr. However, constructing an exception_ptr as well as accessing
  46  * the error requires a call to throw. That means that there will be two calls
  47  * to throw in order to process the exception. For performance sensitive
  48  * applications, this may be unacceptable.
  49  *
  50  * exception_wrapper is designed to handle exception management for both
  51  * convenience and high performance use cases. make_exception_wrapper is
  52  * templated on derived type, allowing us to rethrow the exception properly for
  53  * users that prefer convenience. These explicitly named exception types can
  54  * therefore be handled without any peformance penalty.  exception_wrapper is
  55  * also flexible enough to accept any type. If a caught exception is not of an
  56  * explicitly named type, then std::exception_ptr is used to preserve the
  57  * exception state. For performance sensitive applications, the accessor methods
  58  * can test or extract a pointer to a specific exception type with very little
  59  * overhead.
  60  *
  61  * Example usage:
  62  *
  63  * exception_wrapper globalExceptionWrapper;
  64  *
  65  * // Thread1
  66  * void doSomethingCrazy() {
  67  *   int rc = doSomethingCrazyWithLameReturnCodes();
  68  *   if (rc == NAILED_IT) {
  69  *     globalExceptionWrapper = exception_wrapper();
  70  *   } else if (rc == FACE_PLANT) {
  71  *     globalExceptionWrapper = make_exception_wrapper<FacePlantException>();
  72  *   } else if (rc == FAIL_WHALE) {
  73  *     globalExceptionWrapper = make_exception_wrapper<FailWhaleException>();
  74  *   }
  75  * }
  76  *
  77  * // Thread2: Exceptions are ok!
  78  * void processResult() {
  79  *   try {
  80  *     globalExceptionWrapper.throwException();
  81  *   } catch (const FacePlantException& e) {
  82  *     LOG(ERROR) << "FACEPLANT!";
  83  *   } catch (const FailWhaleException& e) {
  84  *     LOG(ERROR) << "FAILWHALE!";
  85  *   }
  86  * }
  87  *
  88  * // Thread2: Exceptions are bad!
  89  * void processResult() {
  90  *   globalExceptionWrapper.with_exception(
  91  *       [&](FacePlantException& faceplant) {
  92  *         LOG(ERROR) << "FACEPLANT";
  93  *       }) ||
  94  *   globalExceptionWrapper.with_exception(
  95  *       [&](FailWhaleException& failwhale) {
  96  *         LOG(ERROR) << "FAILWHALE!";
  97  *       }) ||
  98  *   LOG(FATAL) << "Unrecognized exception";
  99  * }
 100  *
 101  */
 102 class exception_wrapper {
 103  protected:
 104   template <typename Ex>
 105   struct optimize;
 106
 107  public:
 108   exception_wrapper() = default;
 109
 110   // Implicitly construct an exception_wrapper from a qualifying exception.
 111   // See the optimize struct for details.
 112   template <typename Ex, typename =
 113     typename std::enable_if<optimize<typename std::decay<Ex>::type>::value>
 114     ::type>
 115   /* implicit */ exception_wrapper(Ex&& exn) {
 116     typedef typename std::decay<Ex>::type DEx;
 117     item_ = std::make_shared<DEx>(std::forward<Ex>(exn));
 118     throwfn_ = folly::detail::Thrower<DEx>::doThrow;
 119   }
 120
 121   // The following two constructors are meant to emulate the behavior of
 122   // try_and_catch in performance sensitive code as well as to be flexible
 123   // enough to wrap exceptions of unknown type. There is an overload that
 124   // takes an exception reference so that the wrapper can extract and store
 125   // the exception's type and what() when possible.
 126   //
 127   // The canonical use case is to construct an all-catching exception wrapper
 128   // with minimal overhead like so:
 129   //
 130   //   try {
 131   //     // some throwing code
 132   //   } catch (const std::exception& e) {
 133   //     // won't lose e's type and what()
 134   //     exception_wrapper ew{std::current_exception(), e};
 135   //   } catch (...) {
 136   //     // everything else
 137   //     exception_wrapper ew{std::current_exception()};
 138   //   }
 139   //
 140   // try_and_catch is cleaner and preferable. Use it unless you're sure you need
 141   // something like this instead.
 142   template <typename Ex>
 143   explicit exception_wrapper(std::exception_ptr eptr, Ex& exn) {
 144     assign_eptr(eptr, exn);
 145   }
 146
 147   explicit exception_wrapper(std::exception_ptr eptr) {
 148     assign_eptr(eptr);
 149   }
 150
 151   void throwException() const {
 152     if (throwfn_) {
 153       throwfn_(item_.get());
 154     } else if (eptr_) {
 155       std::rethrow_exception(eptr_);
 156     }
 157   }
 158
 159   explicit operator bool() const {
 160     return item_ || eptr_;
 161   }
 162
 163   // This implementation is similar to std::exception_ptr's implementation
 164   // where two exception_wrappers are equal when the address in the underlying
 165   // reference field both point to the same exception object.  The reference
 166   // field remains the same when the exception_wrapper is copied or when
 167   // the exception_wrapper is "rethrown".
 168   bool operator==(const exception_wrapper& a) const {
 169     if (item_) {
 170       return a.item_ && item_.get() == a.item_.get();
 171     } else {
 172       return eptr_ == a.eptr_;
 173     }
 174   }
 175
 176   bool operator!=(const exception_wrapper& a) const {
 177     return !(*this == a);
 178   }
 179
 180   // This will return a non-nullptr only if the exception is held as a
 181   // copy.  It is the only interface which will distinguish between an
 182   // exception held this way, and by exception_ptr.  You probably
 183   // shouldn't use it at all.
 184   std::exception* getCopied() { return item_.get(); }
 185   const std::exception* getCopied() const { return item_.get(); }
 186
 187   fbstring what() const {
 188     if (item_) {
 189       return exceptionStr(*item_);
 190     } else if (eptr_) {
 191       return estr_;
 192     } else {
 193       return fbstring();
 194     }
 195   }
 196
 197   fbstring class_name() const {
 198     if (item_) {
 199       auto& i = *item_;
 200       return demangle(typeid(i));
 201     } else if (eptr_) {
 202       return ename_;
 203     } else {
 204       return fbstring();
 205     }
 206   }
 207
 208   template <class Ex>
 209   bool is_compatible_with() const {
 210     if (item_) {
 211       return dynamic_cast<const Ex*>(item_.get());
 212     } else if (eptr_) {
 213       try {
 214         std::rethrow_exception(eptr_);
 215       } catch (typename std::decay<Ex>::type&) {
 216         return true;
 217       } catch (...) {
 218         // fall through
 219       }
 220     }
 221     return false;
 222   }
 223
 224   template <class F>
 225   bool with_exception(F&& f) {
 226     using arg_type = typename functor_traits<F>::arg_type_decayed;
 227     return with_exception<arg_type>(std::forward<F>(f));
 228   }
 229
 230   template <class F>
 231   bool with_exception(F&& f) const {
 232     using arg_type = typename functor_traits<F>::arg_type_decayed;
 233     return with_exception<const arg_type>(std::forward<F>(f));
 234   }
 235
 236   // If this exception wrapper wraps an exception of type Ex, with_exception
 237   // will call f with the wrapped exception as an argument and return true, and
 238   // will otherwise return false.
 239   template <class Ex, class F>
 240   typename std::enable_if<
 241     std::is_base_of<std::exception, typename std::decay<Ex>::type>::value,
 242     bool>::type
 243   with_exception(F f) {
 244     return with_exception1<typename std::decay<Ex>::type>(f, this);
 245   }
 246
 247   // Const overload
 248   template <class Ex, class F>
 249   typename std::enable_if<
 250     std::is_base_of<std::exception, typename std::decay<Ex>::type>::value,
 251     bool>::type
 252   with_exception(F f) const {
 253     return with_exception1<const typename std::decay<Ex>::type>(f, this);
 254   }
 255
 256   // Overload for non-exceptions. Always rethrows.
 257   template <class Ex, class F>
 258   typename std::enable_if<
 259     !std::is_base_of<std::exception, typename std::decay<Ex>::type>::value,
 260     bool>::type
 261   with_exception(F f) const {
 262     try {
 263       throwException();
 264     } catch (typename std::decay<Ex>::type& e) {
 265       f(e);
 266       return true;
 267     } catch (...) {
 268       // fall through
 269     }
 270     return false;
 271   }
 272
 273   std::exception_ptr getExceptionPtr() const {
 274     if (eptr_) {
 275       return eptr_;
 276     }
 277
 278     try {
 279       throwException();
 280     } catch (...) {
 281       return std::current_exception();
 282     }
 283     return std::exception_ptr();
 284   }
 285
 286 protected:
 287   template <typename Ex>
 288   struct optimize {
 289     static const bool value =
 290       std::is_base_of<std::exception, Ex>::value &&
 291       std::is_copy_assignable<Ex>::value &&
 292       !std::is_abstract<Ex>::value;
 293   };
 294
 295   template <typename Ex>
 296   void assign_eptr(std::exception_ptr eptr, Ex& e) {
 297     this->eptr_ = eptr;
 298     this->estr_ = exceptionStr(e).toStdString();
 299     this->ename_ = demangle(typeid(e)).toStdString();
 300   }
 301
 302   void assign_eptr(std::exception_ptr eptr) {
 303     this->eptr_ = eptr;
 304   }
 305
 306   // Optimized case: if we know what type the exception is, we can
 307   // store a copy of the concrete type, and a helper function so we
 308   // can rethrow it.
 309   std::shared_ptr<std::exception> item_;
 310   void (*throwfn_)(std::exception*){nullptr};
 311   // Fallback case: store the library wrapper, which is less efficient
 312   // but gets the job done.  Also store exceptionPtr() the name of the
 313   // exception type, so we can at least get those back out without
 314   // having to rethrow.
 315   std::exception_ptr eptr_;
 316   std::string estr_;
 317   std::string ename_;
 318
 319   template <class T, class... Args>
 320   friend exception_wrapper make_exception_wrapper(Args&&... args);
 321
 322 private:
 323   template <typename F>
 324   struct functor_traits {
 325     template <typename T>
 326     struct impl;
 327     template <typename C, typename R, typename A>
 328     struct impl<R(C::*)(A)> { using arg_type = A; };
 329     template <typename C, typename R, typename A>
 330     struct impl<R(C::*)(A) const> { using arg_type = A; };
 331     using functor_decayed = typename std::decay<F>::type;
 332     using functor_op = decltype(&functor_decayed::operator());
 333     using arg_type = typename impl<functor_op>::arg_type;
 334     using arg_type_decayed = typename std::decay<arg_type>::type;
 335   };
 336
 337   // What makes this useful is that T can be exception_wrapper* or
 338   // const exception_wrapper*, and the compiler will use the
 339   // instantiation which works with F.
 340   template <class Ex, class F, class T>
 341   static bool with_exception1(F f, T* that) {
 342     if (that->item_) {
 343       if (auto ex = dynamic_cast<Ex*>(that->item_.get())) {
 344         f(*ex);
 345         return true;
 346       }
 347     } else if (that->eptr_) {
 348       try {
 349         std::rethrow_exception(that->eptr_);
 350       } catch (Ex& e) {
 351         f(e);
 352         return true;
 353       } catch (...) {
 354         // fall through
 355       }
 356     }
 357     return false;
 358   }
 359 };
 360
 361 template <class T, class... Args>
 362 exception_wrapper make_exception_wrapper(Args&&... args) {
 363   exception_wrapper ew;
 364   ew.item_ = std::make_shared<T>(std::forward<Args>(args)...);
 365   ew.throwfn_ = folly::detail::Thrower<T>::doThrow;
 366   return ew;
 367 }
 368
 369 // For consistency with exceptionStr() functions in String.h
 370 inline fbstring exceptionStr(const exception_wrapper& ew) {
 371   return ew.what();
 372 }
 373
 374 /*
 375  * try_and_catch is a simple replacement for try {} catch(){} that allows you to
 376  * specify which derived exceptions you would like to catch and store in an
 377  * exception_wrapper.
 378  *
 379  * Because we cannot build an equivalent of std::current_exception(), we need
 380  * to catch every derived exception that we are interested in catching.
 381  *
 382  * Exceptions should be listed in the reverse order that you would write your
 383  * catch statements (that is, std::exception& should be first).
 384  *
 385  * NOTE: Although implemented as a derived class (for syntactic delight), don't
 386  * be confused - you should not pass around try_and_catch objects!
 387  *
 388  * Example Usage:
 389  *
 390  * // This catches my runtime_error and if I call throwException() on ew, it
 391  * // will throw a runtime_error
 392  * auto ew = folly::try_and_catch<std::exception, std::runtime_error>([=]() {
 393  *   if (badThingHappens()) {
 394  *     throw std::runtime_error("ZOMG!");
 395  *   }
 396  * });
 397  *
 398  * // This will catch the exception and if I call throwException() on ew, it
 399  * // will throw a std::exception
 400  * auto ew = folly::try_and_catch<std::exception, std::runtime_error>([=]() {
 401  *   if (badThingHappens()) {
 402  *     throw std::exception();
 403  *   }
 404  * });
 405  *
 406  * // This will not catch the exception and it will be thrown.
 407  * auto ew = folly::try_and_catch<std::runtime_error>([=]() {
 408  *   if (badThingHappens()) {
 409  *     throw std::exception();
 410  *   }
 411  * });
 412  */
 413
 414 template <typename... Exceptions>
 415 class try_and_catch;
 416
 417 template <typename LastException, typename... Exceptions>
 418 class try_and_catch<LastException, Exceptions...> :
 419     public try_and_catch<Exceptions...> {
 420  public:
 421   template <typename F>
 422   explicit try_and_catch(F&& fn) : Base() {
 423     call_fn(fn);
 424   }
 425
 426  protected:
 427   typedef try_and_catch<Exceptions...> Base;
 428
 429   try_and_catch() : Base() {}
 430
 431   template <typename Ex>
 432   typename std::enable_if<!exception_wrapper::optimize<Ex>::value>::type
 433   assign_exception(Ex& e, std::exception_ptr eptr) {
 434     exception_wrapper::assign_eptr(eptr, e);
 435   }
 436
 437   template <typename Ex>
 438   typename std::enable_if<exception_wrapper::optimize<Ex>::value>::type
 439   assign_exception(Ex& e, std::exception_ptr /*eptr*/) {
 440     this->item_ = std::make_shared<Ex>(e);
 441     this->throwfn_ = folly::detail::Thrower<Ex>::doThrow;
 442   }
 443
 444   template <typename F>
 445   void call_fn(F&& fn) {
 446     try {
 447       Base::call_fn(std::move(fn));
 448     } catch (LastException& e) {
 449       if (typeid(e) == typeid(LastException&)) {
 450         assign_exception(e, std::current_exception());
 451       } else {
 452         exception_wrapper::assign_eptr(std::current_exception(), e);
 453       }
 454     }
 455   }
 456 };
 457
 458 template<>
 459 class try_and_catch<> : public exception_wrapper {
 460  public:
 461   try_and_catch() = default;
 462
 463  protected:
 464   template <typename F>
 465   void call_fn(F&& fn) {
 466     fn();
 467   }
 468 };
 469 }