folly/futures/Future.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 #pragma once
  18
  19 #include <algorithm>
  20 #include <exception>
  21 #include <functional>
  22 #include <memory>
  23 #include <type_traits>
  24 #include <vector>
  25
  26 #include <folly/MoveWrapper.h>
  27 #include <folly/futures/Deprecated.h>
  28 #include <folly/futures/DrivableExecutor.h>
  29 #include <folly/futures/Promise.h>
  30 #include <folly/futures/Try.h>
  31 #include <folly/futures/FutureException.h>
  32 #include <folly/futures/detail/Types.h>
  33
  34 namespace folly {
  35
  36 template <class> struct Promise;
  37
  38 template <typename T>
  39 struct isFuture : std::false_type {
  40   typedef T Inner;
  41 };
  42
  43 template <typename T>
  44 struct isFuture<Future<T>> : std::true_type {
  45   typedef T Inner;
  46 };
  47
  48 template <typename T>
  49 struct isTry : std::false_type {};
  50
  51 template <typename T>
  52 struct isTry<Try<T>> : std::true_type {};
  53
  54 namespace detail {
  55
  56 template <class> struct Core;
  57 template <class...> struct VariadicContext;
  58
  59 template<typename F, typename... Args>
  60 using resultOf = decltype(std::declval<F>()(std::declval<Args>()...));
  61
  62 template <typename...>
  63 struct ArgType;
  64
  65 template <typename Arg, typename... Args>
  66 struct ArgType<Arg, Args...> {
  67   typedef Arg FirstArg;
  68 };
  69
  70 template <>
  71 struct ArgType<> {
  72   typedef void FirstArg;
  73 };
  74
  75 template <bool isTry, typename F, typename... Args>
  76 struct argResult {
  77   typedef resultOf<F, Args...> Result;
  78 };
  79
  80 template<typename F, typename... Args>
  81 struct callableWith {
  82     template<typename T,
  83              typename = detail::resultOf<T, Args...>>
  84     static constexpr std::true_type
  85     check(std::nullptr_t) { return std::true_type{}; };
  86
  87     template<typename>
  88     static constexpr std::false_type
  89     check(...) { return std::false_type{}; };
  90
  91     typedef decltype(check<F>(nullptr)) type;
  92     static constexpr bool value = type::value;
  93 };
  94
  95 template<typename T, typename F>
  96 struct callableResult {
  97   typedef typename std::conditional<
  98     callableWith<F>::value,
  99     detail::argResult<false, F>,
 100     typename std::conditional<
 101       callableWith<F, Try<T>&&>::value,
 102       detail::argResult<true, F, Try<T>&&>,
 103       typename std::conditional<
 104         callableWith<F, Try<T>&>::value,
 105         detail::argResult<true, F, Try<T>&>,
 106         typename std::conditional<
 107           callableWith<F, T&&>::value,
 108           detail::argResult<false, F, T&&>,
 109           detail::argResult<false, F, T&>>::type>::type>::type>::type Arg;
 110   typedef isFuture<typename Arg::Result> ReturnsFuture;
 111   typedef Future<typename ReturnsFuture::Inner> Return;
 112 };
 113
 114 template<typename F>
 115 struct callableResult<void, F> {
 116   typedef typename std::conditional<
 117     callableWith<F>::value,
 118     detail::argResult<false, F>,
 119     typename std::conditional<
 120       callableWith<F, Try<void>&&>::value,
 121       detail::argResult<true, F, Try<void>&&>,
 122       detail::argResult<true, F, Try<void>&>>::type>::type Arg;
 123   typedef isFuture<typename Arg::Result> ReturnsFuture;
 124   typedef Future<typename ReturnsFuture::Inner> Return;
 125 };
 126
 127 template <typename L>
 128 struct Extract : Extract<decltype(&L::operator())> { };
 129
 130 template <typename Class, typename R, typename... Args>
 131 struct Extract<R(Class::*)(Args...) const> {
 132   typedef isFuture<R> ReturnsFuture;
 133   typedef Future<typename ReturnsFuture::Inner> Return;
 134   typedef typename ReturnsFuture::Inner RawReturn;
 135   typedef typename ArgType<Args...>::FirstArg FirstArg;
 136 };
 137
 138 template <typename Class, typename R, typename... Args>
 139 struct Extract<R(Class::*)(Args...)> {
 140   typedef isFuture<R> ReturnsFuture;
 141   typedef Future<typename ReturnsFuture::Inner> Return;
 142   typedef typename ReturnsFuture::Inner RawReturn;
 143   typedef typename ArgType<Args...>::FirstArg FirstArg;
 144 };
 145
 146 } // detail
 147
 148 struct Timekeeper;
 149
 150 /// This namespace is for utility functions that would usually be static
 151 /// members of Future, except they don't make sense there because they don't
 152 /// depend on the template type (rather, on the type of their arguments in
 153 /// some cases). This is the least-bad naming scheme we could think of. Some
 154 /// of the functions herein have really-likely-to-collide names, like "map"
 155 /// and "sleep".
 156 namespace futures {
 157   /// Returns a Future that will complete after the specified duration. The
 158   /// Duration typedef of a `std::chrono` duration type indicates the
 159   /// resolution you can expect to be meaningful (milliseconds at the time of
 160   /// writing). Normally you wouldn't need to specify a Timekeeper, we will
 161   /// use the global futures timekeeper (we run a thread whose job it is to
 162   /// keep time for futures timeouts) but we provide the option for power
 163   /// users.
 164   ///
 165   /// The Timekeeper thread will be lazily created the first time it is
 166   /// needed. If your program never uses any timeouts or other time-based
 167   /// Futures you will pay no Timekeeper thread overhead.
 168   Future<void> sleep(Duration, Timekeeper* = nullptr);
 169 }
 170
 171 template <class T>
 172 class Future {
 173  public:
 174   typedef T value_type;
 175
 176   // not copyable
 177   Future(Future const&) = delete;
 178   Future& operator=(Future const&) = delete;
 179
 180   // movable
 181   Future(Future&&) noexcept;
 182   Future& operator=(Future&&);
 183
 184   // makeFuture
 185   template <class F = T>
 186   /* implicit */
 187   Future(const typename std::enable_if<!std::is_void<F>::value, F>::type& val);
 188
 189   template <class F = T>
 190   /* implicit */
 191   Future(typename std::enable_if<!std::is_void<F>::value, F>::type&& val);
 192
 193   template <class F = T,
 194             typename std::enable_if<std::is_void<F>::value, int>::type = 0>
 195   Future();
 196
 197   ~Future();
 198
 199   /** Return the reference to result. Should not be called if !isReady().
 200     Will rethrow the exception if an exception has been
 201     captured.
 202     */
 203   typename std::add_lvalue_reference<T>::type
 204   value();
 205   typename std::add_lvalue_reference<const T>::type
 206   value() const;
 207
 208   /// Returns an inactive Future which will call back on the other side of
 209   /// executor (when it is activated).
 210   ///
 211   /// NB remember that Futures activate when they destruct. This is good,
 212   /// it means that this will work:
 213   ///
 214   ///   f.via(e).then(a).then(b);
 215   ///
 216   /// a and b will execute in the same context (the far side of e), because
 217   /// the Future (temporary variable) created by via(e) does not call back
 218   /// until it destructs, which is after then(a) and then(b) have been wired
 219   /// up.
 220   ///
 221   /// But this is still racy:
 222   ///
 223   ///   f = f.via(e).then(a);
 224   ///   f.then(b);
 225   // The ref-qualifier allows for `this` to be moved out so we
 226   // don't get access-after-free situations in chaining.
 227   // https://akrzemi1.wordpress.com/2014/06/02/ref-qualifiers/
 228   template <typename Executor>
 229   Future<T> via(Executor* executor) &&;
 230
 231   /// This variant creates a new future, where the ref-qualifier && version
 232   /// moves `this` out. This one is less efficient but avoids confusing users
 233   /// when "return f.via(x);" fails.
 234   template <typename Executor>
 235   Future<T> via(Executor* executor) &;
 236
 237   /** True when the result (or exception) is ready. */
 238   bool isReady() const;
 239
 240   /** A reference to the Try of the value */
 241   Try<T>& getTry();
 242
 243   /// Block until the future is fulfilled. Returns the value (moved out), or
 244   /// throws the exception. The future must not already have a callback.
 245   T get();
 246
 247   /// Block until the future is fulfilled, or until timed out. Returns the
 248   /// value (moved out), or throws the exception (which might be a TimedOut
 249   /// exception).
 250   T get(Duration dur);
 251
 252   /// Call e->drive() repeatedly until the future is fulfilled. Examples
 253   /// of DrivableExecutor include EventBase and ManualExecutor. Returns the
 254   /// value (moved out), or throws the exception.
 255   T getVia(DrivableExecutor* e);
 256
 257   /** When this Future has completed, execute func which is a function that
 258     takes one of:
 259       (const) Try<T>&&
 260       (const) Try<T>&
 261       (const) Try<T>
 262       (const) T&&
 263       (const) T&
 264       (const) T
 265       (void)
 266
 267     Func shall return either another Future or a value.
 268
 269     A Future for the return type of func is returned.
 270
 271     Future<string> f2 = f1.then([](Try<T>&&) { return string("foo"); });
 272
 273     The Future given to the functor is ready, and the functor may call
 274     value(), which may rethrow if this has captured an exception. If func
 275     throws, the exception will be captured in the Future that is returned.
 276     */
 277   /* TODO n3428 and other async frameworks have something like then(scheduler,
 278      Future), we might want to support a similar API which could be
 279      implemented a little more efficiently than
 280      f.via(executor).then(callback) */
 281   template <typename F, typename R = detail::callableResult<T, F>>
 282   typename R::Return then(F func) {
 283     typedef typename R::Arg Arguments;
 284     return thenImplementation<F, R>(std::move(func), Arguments());
 285   }
 286
 287   /// Variant where func is an member function
 288   ///
 289   ///   struct Worker {
 290   ///     R doWork(Try<T>&&); }
 291   ///
 292   ///   Worker *w;
 293   ///   Future<R> f2 = f1.then(w, &Worker::doWork);
 294   template <typename Caller, typename R, typename... Args>
 295     Future<typename isFuture<R>::Inner>
 296   then(Caller *instance, R(Caller::*func)(Args...));
 297
 298   /// Convenience method for ignoring the value and creating a Future<void>.
 299   /// Exceptions still propagate.
 300   Future<void> then();
 301
 302   /// Set an error callback for this Future. The callback should take a single
 303   /// argument of the type that you want to catch, and should return a value of
 304   /// the same type as this Future, or a Future of that type (see overload
 305   /// below). For instance,
 306   ///
 307   /// makeFuture()
 308   ///   .then([] {
 309   ///     throw std::runtime_error("oh no!");
 310   ///     return 42;
 311   ///   })
 312   ///   .onError([] (std::runtime_error& e) {
 313   ///     LOG(INFO) << "std::runtime_error: " << e.what();
 314   ///     return -1; // or makeFuture<int>(-1)
 315   ///   });
 316   template <class F>
 317   typename std::enable_if<
 318     !detail::Extract<F>::ReturnsFuture::value,
 319     Future<T>>::type
 320   onError(F&& func);
 321
 322   /// Overload of onError where the error callback returns a Future<T>
 323   template <class F>
 324   typename std::enable_if<
 325     detail::Extract<F>::ReturnsFuture::value,
 326     Future<T>>::type
 327   onError(F&& func);
 328
 329   /// This is not the method you're looking for.
 330   ///
 331   /// This needs to be public because it's used by make* and when*, and it's
 332   /// not worth listing all those and their fancy template signatures as
 333   /// friends. But it's not for public consumption.
 334   template <class F>
 335   void setCallback_(F&& func);
 336
 337   /// A Future's callback is executed when all three of these conditions have
 338   /// become true: it has a value (set by the Promise), it has a callback (set
 339   /// by then), and it is active (active by default).
 340   ///
 341   /// Inactive Futures will activate upon destruction.
 342   Future<T>& activate() & {
 343     core_->activate();
 344     return *this;
 345   }
 346   Future<T>& deactivate() & {
 347     core_->deactivate();
 348     return *this;
 349   }
 350   Future<T> activate() && {
 351     core_->activate();
 352     return std::move(*this);
 353   }
 354   Future<T> deactivate() && {
 355     core_->deactivate();
 356     return std::move(*this);
 357   }
 358
 359   bool isActive() {
 360     return core_->isActive();
 361   }
 362
 363   template <class E>
 364   void raise(E&& exception) {
 365     raise(make_exception_wrapper<typename std::remove_reference<E>::type>(
 366         std::move(exception)));
 367   }
 368
 369   /// Raise an interrupt. If the promise holder has an interrupt
 370   /// handler it will be called and potentially stop asynchronous work from
 371   /// being done. This is advisory only - a promise holder may not set an
 372   /// interrupt handler, or may do anything including ignore. But, if you know
 373   /// your future supports this the most likely result is stopping or
 374   /// preventing the asynchronous operation (if in time), and the promise
 375   /// holder setting an exception on the future. (That may happen
 376   /// asynchronously, of course.)
 377   void raise(exception_wrapper interrupt);
 378
 379   void cancel() {
 380     raise(FutureCancellation());
 381   }
 382
 383   /// Throw TimedOut if this Future does not complete within the given
 384   /// duration from now. The optional Timeekeeper is as with futures::sleep().
 385   Future<T> within(Duration, Timekeeper* = nullptr);
 386
 387   /// Throw the given exception if this Future does not complete within the
 388   /// given duration from now. The optional Timeekeeper is as with
 389   /// futures::sleep().
 390   template <class E>
 391   Future<T> within(Duration, E exception, Timekeeper* = nullptr);
 392
 393   /// Delay the completion of this Future for at least this duration from
 394   /// now. The optional Timekeeper is as with futures::sleep().
 395   Future<T> delayed(Duration, Timekeeper* = nullptr);
 396
 397   /// Block until this Future is complete. Returns a new Future containing the
 398   /// result.
 399   Future<T> wait();
 400
 401   /// Block until this Future is complete or until the given Duration passes.
 402   /// Returns a new Future which either contains the result or is incomplete,
 403   /// depending on whether the Duration passed.
 404   Future<T> wait(Duration);
 405
 406   /// Call e->drive() repeatedly until the future is fulfilled. Examples
 407   /// of DrivableExecutor include EventBase and ManualExecutor. Returns a
 408   /// reference to this Future so that you can chain calls if desired.
 409   /// value (moved out), or throws the exception.
 410   Future<T>& waitVia(DrivableExecutor* e) &;
 411
 412   /// Overload of waitVia() for rvalue Futures
 413   Future<T> waitVia(DrivableExecutor* e) &&;
 414
 415  private:
 416   typedef detail::Core<T>* corePtr;
 417
 418   // shared core state object
 419   corePtr core_;
 420
 421   explicit
 422   Future(corePtr obj) : core_(obj) {}
 423
 424   void detach();
 425
 426   void throwIfInvalid() const;
 427
 428   friend class Promise<T>;
 429
 430   // Variant: returns a value
 431   // e.g. f.then([](Try<T> t){ return t.value(); });
 432   template <typename F, typename R, bool isTry, typename... Args>
 433   typename std::enable_if<!R::ReturnsFuture::value, typename R::Return>::type
 434   thenImplementation(F func, detail::argResult<isTry, F, Args...>);
 435
 436   // Variant: returns a Future
 437   // e.g. f.then([](Try<T> t){ return makeFuture<T>(t); });
 438   template <typename F, typename R, bool isTry, typename... Args>
 439   typename std::enable_if<R::ReturnsFuture::value, typename R::Return>::type
 440   thenImplementation(F func, detail::argResult<isTry, F, Args...>);
 441 };
 442
 443 /**
 444   Make a completed Future by moving in a value. e.g.
 445
 446     string foo = "foo";
 447     auto f = makeFuture(std::move(foo));
 448
 449   or
 450
 451     auto f = makeFuture<string>("foo");
 452 */
 453 template <class T>
 454 Future<typename std::decay<T>::type> makeFuture(T&& t);
 455
 456 /** Make a completed void Future. */
 457 Future<void> makeFuture();
 458
 459 /** Make a completed Future by executing a function. If the function throws
 460   we capture the exception, otherwise we capture the result. */
 461 template <class F>
 462 auto makeFutureTry(
 463   F&& func,
 464   typename std::enable_if<
 465     !std::is_reference<F>::value, bool>::type sdf = false)
 466   -> Future<decltype(func())>;
 467
 468 template <class F>
 469 auto makeFutureTry(
 470   F const& func)
 471   -> Future<decltype(func())>;
 472
 473 /// Make a failed Future from an exception_ptr.
 474 /// Because the Future's type cannot be inferred you have to specify it, e.g.
 475 ///
 476 ///   auto f = makeFuture<string>(std::current_exception());
 477 template <class T>
 478 Future<T> makeFuture(std::exception_ptr const& e) DEPRECATED;
 479
 480 /// Make a failed Future from an exception_wrapper.
 481 template <class T>
 482 Future<T> makeFuture(exception_wrapper ew);
 483
 484 /** Make a Future from an exception type E that can be passed to
 485   std::make_exception_ptr(). */
 486 template <class T, class E>
 487 typename std::enable_if<std::is_base_of<std::exception, E>::value,
 488                         Future<T>>::type
 489 makeFuture(E const& e);
 490
 491 /** Make a Future out of a Try */
 492 template <class T>
 493 Future<T> makeFuture(Try<T>&& t);
 494
 495 /*
 496  * Return a new Future that will call back on the given Executor.
 497  * This is just syntactic sugar for makeFuture().via(executor)
 498  *
 499  * @param executor the Executor to call back on
 500  *
 501  * @returns a void Future that will call back on the given executor
 502  */
 503 template <typename Executor>
 504 Future<void> via(Executor* executor);
 505
 506 /** When all the input Futures complete, the returned Future will complete.
 507   Errors do not cause early termination; this Future will always succeed
 508   after all its Futures have finished (whether successfully or with an
 509   error).
 510
 511   The Futures are moved in, so your copies are invalid. If you need to
 512   chain further from these Futures, use the variant with an output iterator.
 513
 514   XXX is this still true?
 515   This function is thread-safe for Futures running on different threads.
 516
 517   The return type for Future<T> input is a Future<std::vector<Try<T>>>
 518   */
 519 template <class InputIterator>
 520 Future<std::vector<Try<
 521   typename std::iterator_traits<InputIterator>::value_type::value_type>>>
 522 whenAll(InputIterator first, InputIterator last);
 523
 524 /// This version takes a varying number of Futures instead of an iterator.
 525 /// The return type for (Future<T1>, Future<T2>, ...) input
 526 /// is a Future<std::tuple<Try<T1>, Try<T2>, ...>>.
 527 /// The Futures are moved in, so your copies are invalid.
 528 template <typename... Fs>
 529 typename detail::VariadicContext<
 530   typename std::decay<Fs>::type::value_type...>::type
 531 whenAll(Fs&&... fs);
 532
 533 /** The result is a pair of the index of the first Future to complete and
 534   the Try. If multiple Futures complete at the same time (or are already
 535   complete when passed in), the "winner" is chosen non-deterministically.
 536
 537   This function is thread-safe for Futures running on different threads.
 538   */
 539 template <class InputIterator>
 540 Future<std::pair<
 541   size_t,
 542   Try<typename std::iterator_traits<InputIterator>::value_type::value_type>>>
 543 whenAny(InputIterator first, InputIterator last);
 544
 545 /** when n Futures have completed, the Future completes with a vector of
 546   the index and Try of those n Futures (the indices refer to the original
 547   order, but the result vector will be in an arbitrary order)
 548
 549   Not thread safe.
 550   */
 551 template <class InputIterator>
 552 Future<std::vector<std::pair<
 553   size_t,
 554   Try<typename std::iterator_traits<InputIterator>::value_type::value_type>>>>
 555 whenN(InputIterator first, InputIterator last, size_t n);
 556
 557 } // folly
 558
 559 #include <folly/futures/Future-inl.h>