include/simgrid/kernel/future.hpp

   1 /* Copyright (c) 2016-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SIMGRID_KERNEL_FUTURE_HPP
   8 #define SIMGRID_KERNEL_FUTURE_HPP
   9
  10 #include <functional>
  11 #include <future>
  12 #include <memory>
  13 #include <utility>
  14 #include <type_traits>
  15
  16 #include <boost/optional.hpp>
  17
  18 #include <xbt/base.h>
  19 #include <xbt/functional.hpp>
  20 #include <xbt/future.hpp>
  21
  22 namespace simgrid {
  23 namespace kernel {
  24
  25 // There are the public classes:
  26 template<class T> class Future;
  27 template<class T> class Promise;
  28
  29 // Those are implementation details:
  30 enum class FutureStatus;
  31 template<class T> class FutureState;
  32
  33 enum class FutureStatus {
  34   not_ready,
  35   ready,
  36   done,
  37 };
  38
  39 template<class T>
  40 struct is_future : std::false_type {};
  41 template<class T>
  42 struct is_future<Future<T>> : std::true_type {};
  43
  44 /** Bases stuff for all @ref simgrid::kernel::FutureState<T> */
  45 class FutureStateBase {
  46 public:
  47   // No copy/move:
  48   FutureStateBase(FutureStateBase const&) = delete;
  49   FutureStateBase& operator=(FutureStateBase const&) = delete;
  50
  51   XBT_PUBLIC void schedule(simgrid::xbt::Task<void()>&& job);
  52
  53   void set_exception(std::exception_ptr exception)
  54   {
  55     xbt_assert(exception_ == nullptr);
  56     if (status_ != FutureStatus::not_ready)
  57       throw std::future_error(std::future_errc::promise_already_satisfied);
  58     exception_ = std::move(exception);
  59     this->set_ready();
  60   }
  61
  62   void set_continuation(simgrid::xbt::Task<void()>&& continuation)
  63   {
  64     xbt_assert(not continuation_);
  65     switch (status_) {
  66     case FutureStatus::done:
  67       // This is not supposed to happen if continuation is set
  68       // via the Promise:
  69       xbt_die("Set continuation on finished future");
  70       break;
  71     case FutureStatus::ready:
  72       // The future is ready, execute the continuation directly.
  73       // We might execute it from the event loop instead:
  74       schedule(std::move(continuation));
  75       break;
  76     case FutureStatus::not_ready:
  77       // The future is not ready so we mast keep the continuation for
  78       // executing it later:
  79       continuation_ = std::move(continuation);
  80       break;
  81     default:
  82       DIE_IMPOSSIBLE;
  83     }
  84   }
  85
  86   FutureStatus get_status() const
  87   {
  88     return status_;
  89   }
  90
  91   bool is_ready() const
  92   {
  93     return status_ == FutureStatus::ready;
  94   }
  95
  96 protected:
  97   FutureStateBase() = default;
  98   ~FutureStateBase() = default;
  99
 100   /** Set the future as ready and trigger the continuation */
 101   void set_ready()
 102   {
 103     status_ = FutureStatus::ready;
 104     if (continuation_) {
 105       // We unregister the continuation before executing it.
 106       // We need to do this becase the current implementation of the
 107       // continuation has a shared_ptr to the FutureState.
 108       auto continuation = std::move(continuation_);
 109       this->schedule(std::move(continuation));
 110     }
 111   }
 112
 113   /** Set the future as done and raise an exception if any
 114    *
 115    *  This does half the job of `.get()`.
 116    **/
 117   void resolve()
 118   {
 119     if (status_ != FutureStatus::ready)
 120       xbt_die("Deadlock: this future is not ready");
 121     status_ = FutureStatus::done;
 122     if (exception_) {
 123       std::exception_ptr exception = std::move(exception_);
 124       exception_ = nullptr;
 125       std::rethrow_exception(std::move(exception));
 126     }
 127   }
 128
 129 private:
 130   FutureStatus status_ = FutureStatus::not_ready;
 131   std::exception_ptr exception_;
 132   simgrid::xbt::Task<void()> continuation_;
 133 };
 134
 135 /** Shared state for future and promises
 136  *
 137  *  You are not expected to use them directly but to create them
 138  *  implicitely through a @ref simgrid::kernel::Promise.
 139  *  Alternatively kernel operations could inherit or contain FutureState
 140  *  if they are managed with std::shared_ptr.
 141  **/
 142 template<class T>
 143 class FutureState : public FutureStateBase {
 144 public:
 145
 146   void set_value(T value)
 147   {
 148     if (this->get_status() != FutureStatus::not_ready)
 149       throw std::future_error(std::future_errc::promise_already_satisfied);
 150     value_ = std::move(value);
 151     this->set_ready();
 152   }
 153
 154   T get()
 155   {
 156     this->resolve();
 157     xbt_assert(this->value_);
 158     auto result = std::move(this->value_.get());
 159     this->value_ = boost::optional<T>();
 160     return result;
 161   }
 162
 163 private:
 164   boost::optional<T> value_;
 165 };
 166
 167 template<class T>
 168 class FutureState<T&> : public FutureStateBase {
 169 public:
 170   void set_value(T& value)
 171   {
 172     if (this->get_status() != FutureStatus::not_ready)
 173       throw std::future_error(std::future_errc::promise_already_satisfied);
 174     value_ = &value;
 175     this->set_ready();
 176   }
 177
 178   T& get()
 179   {
 180     this->resolve();
 181     xbt_assert(this->value_);
 182     T* result = value_;
 183     value_ = nullptr;
 184     return *result;
 185   }
 186
 187 private:
 188   T* value_ = nullptr;
 189 };
 190
 191 template<>
 192 class FutureState<void> : public FutureStateBase {
 193 public:
 194   void set_value()
 195   {
 196     if (this->get_status() != FutureStatus::not_ready)
 197       throw std::future_error(std::future_errc::promise_already_satisfied);
 198     this->set_ready();
 199   }
 200
 201   void get()
 202   {
 203     this->resolve();
 204   }
 205 };
 206
 207 template <class T> void bind_promise(Promise<T>&& promise, Future<T> future)
 208 {
 209   class PromiseBinder {
 210   public:
 211     explicit PromiseBinder(Promise<T>&& promise) : promise_(std::move(promise)) {}
 212     void operator()(Future<T> future) { simgrid::xbt::set_promise(promise_, future); }
 213
 214   private:
 215     Promise<T> promise_;
 216   };
 217   future.then_(PromiseBinder(std::move(promise)));
 218 }
 219
 220 template <class T> Future<T> unwrap_future(Future<Future<T>> future);
 221
 222 template <class T>
 223 XBT_ATTRIB_DEPRECATED_v323("Please use bind_promise") void bindPromise(Promise<T> promise, Future<T> future)
 224 {
 225   bind_promise(promise, future);
 226 }
 227 template <class T>
 228 XBT_ATTRIB_DEPRECATED_v323("Please use unwrap_future") Future<T> unwrapFuture(Future<Future<T>> future)
 229 {
 230   unwrap_future(future);
 231 }
 232
 233 /** Result of some (probably) asynchronous operation in the SimGrid kernel
 234  *
 235  * @ref simgrid::simix::Future and @ref simgrid::simix::Future provide an
 236  * abstration for asynchronous stuff happening in the SimGrid kernel. They
 237  * are based on C++1z futures.
 238  *
 239  * The future represents a value which will be available at some point when this
 240  * asynchronous operaiont is finished. Alternatively, if this operations fails,
 241  * the result of the operation might be an exception.
 242  *
 243  *  As the operation is possibly no terminated yet, we cannot get the result
 244  *  yet. Moreover, as we cannot block in the SimGrid kernel we cannot wait for
 245  *  it. However, we can attach some code/callback/continuation which will be
 246  *  executed when the operation terminates.
 247  *
 248  *  Example of the API (`simgrid::kernel::createProcess` does not exist):
 249  *  <pre>
 250  *  // Create a new process using the Worker code, this process returns
 251  *  // a std::string:
 252  *  simgrid::kernel::Future<std::string> future =
 253  *     simgrid::kernel::createProcess("worker42", host, Worker(42));
 254  *  // At this point, we just created the process so the result is not available.
 255  *  // However, we can attach some work do be done with this result:
 256  *  future.then([](simgrid::kernel::Future<std::string> result) {
 257  *    // This code is called when the operation is completed so the result is
 258  *    // available:
 259  *    try {
 260  *      // Try to get value, this might throw an exception if the operation
 261  *      // failed (such as an exception throwed by the worker process):
 262  *      std::string value = result.get();
 263  *      XBT_INFO("Value: %s", value.c_str());
 264  *    }
 265  *    catch(std::exception& e) {
 266  *      // This is an exception from the asynchronous operation:
 267  *      XBT_INFO("Error: %e", e.what());
 268  *    }
 269  *  );
 270  *  </pre>
 271  *
 272  *  This is based on C++1z std::future but with some differences:
 273  *
 274  *  * there is no thread synchronization (atomic, mutex, condition variable,
 275  *    etc.) because everything happens in the SimGrid event loop;
 276  *
 277  *  * it is purely asynchronous, you are expected to use `.then()`;
 278  *
 279  *  * inside the `.then()`, `.get()` can be used;
 280  *
 281  *  * `.get()` can only be used when `.is_ready()` (as everything happens in
 282  *     a single-thread, the future would be guaranted to deadlock if `.get()`
 283  *     is called when the future is not ready);
 284  *
 285  *  * there is no future chaining support for now (`.then().then()`);
 286  *
 287  *  * there is no sharing (`shared_future`) for now.
 288  */
 289 template<class T>
 290 class Future {
 291 public:
 292   Future() = default;
 293   explicit Future(std::shared_ptr<FutureState<T>> state) : state_(std::move(state)) {}
 294   ~Future() = default;
 295
 296   // Move type:
 297   Future(Future&) = delete;
 298   Future& operator=(Future&) = delete;
 299   Future(Future&& that) : state_(std::move(that.state_)) {}
 300   Future& operator=(Future&& that)
 301   {
 302     state_ = std::move(that.state_);
 303     return *this;
 304   }
 305
 306   /** Whether the future is valid:.
 307    *
 308    *  A future which as been used (`.then` of `.get`) becomes invalid.
 309    *
 310    *  We can use `.then` on a valid future.
 311    */
 312   bool valid() const
 313   {
 314     return state_ != nullptr;
 315   }
 316
 317   /** Whether the future is ready
 318    *
 319    *  A future is ready when it has an associated value or exception.
 320    *
 321    *  We can use `.get()` on ready futures.
 322    **/
 323   bool is_ready() const
 324   {
 325     return state_ != nullptr && state_->is_ready();
 326   }
 327
 328   /** Attach a continuation to this future
 329    *
 330    *  This is like .then() but avoid the creation of a new future.
 331    */
 332   template<class F>
 333   void then_(F continuation)
 334   {
 335     if (state_ == nullptr)
 336       throw std::future_error(std::future_errc::no_state);
 337     // Give shared-ownership to the continuation:
 338     auto state = std::move(state_);
 339     state->set_continuation(simgrid::xbt::make_task(std::move(continuation), state));
 340   }
 341
 342   /** Attach a continuation to this future
 343    *
 344    *  This version never does future unwrapping.
 345    */
 346   template <class F> auto then_no_unwrap(F continuation) -> Future<decltype(continuation(std::move(*this)))>
 347   {
 348     typedef decltype(continuation(std::move(*this))) R;
 349     if (state_ == nullptr)
 350       throw std::future_error(std::future_errc::no_state);
 351     auto state = std::move(state_);
 352     // Create a new future...
 353     Promise<R> promise;
 354     Future<R> future = promise.get_future();
 355     // ...and when the current future is ready...
 356     state->set_continuation(simgrid::xbt::make_task(
 357         [](Promise<R> promise, std::shared_ptr<FutureState<T>> state, F continuation) {
 358           // ...set the new future value by running the continuation.
 359           Future<T> future(std::move(state));
 360           simgrid::xbt::fulfill_promise(promise, [&continuation, &future] { return continuation(std::move(future)); });
 361         },
 362         std::move(promise), state, std::move(continuation)));
 363     return future;
 364   }
 365
 366   template <class F>
 367   XBT_ATTRIB_DEPRECATED_v323("Please use then_no_unwrap") auto thenNoUnwrap(F continuation)
 368       -> Future<decltype(continuation(std::move(*this)))>
 369   {
 370     then_no_unwrap(continuation);
 371   }
 372
 373   /** Attach a continuation to this future
 374    *
 375    *  The future must be valid in order to make this call.
 376    *  The continuation is executed when the future becomes ready.
 377    *  The future becomes invalid after this call.
 378    *
 379    * @param continuation This function is called with a ready future
 380    *                     the future is ready
 381    * @exception std::future_error no state is associated with the future
 382    */
 383   template <class F>
 384   auto then(F continuation) -> typename std::enable_if<not is_future<decltype(continuation(std::move(*this)))>::value,
 385                                                        Future<decltype(continuation(std::move(*this)))>>::type
 386   {
 387     return this->then_no_unwrap(std::move(continuation));
 388   }
 389
 390   /** Attach a continuation to this future (future chaining) */
 391   template<class F>
 392   auto then(F continuation)
 393   -> typename std::enable_if<
 394        is_future<decltype(continuation(std::move(*this)))>::value,
 395        decltype(continuation(std::move(*this)))
 396      >::type
 397   {
 398     return unwrap_future(this->then_no_unwrap(std::move(continuation)));
 399   }
 400
 401   /** Get the value from the future
 402    *
 403    *  The future must be valid and ready in order to make this call.
 404    *  std::future blocks when the future is not ready but we are
 405    *  completely single-threaded so blocking would be a deadlock.
 406    *  After the call, the future becomes invalid.
 407    *
 408    *  @return                      value of the future
 409    *  @exception any               Exception from the future
 410    *  @exception std::future_error no state is associated with the future
 411    */
 412   T get()
 413   {
 414     if (state_ == nullptr)
 415       throw std::future_error(std::future_errc::no_state);
 416     std::shared_ptr<FutureState<T>> state = std::move(state_);
 417     return state->get();
 418   }
 419
 420 private:
 421   std::shared_ptr<FutureState<T>> state_;
 422 };
 423
 424 template <class T> Future<T> unwrap_future(Future<Future<T>> future)
 425 {
 426   Promise<T> promise;
 427   Future<T> result = promise.get_future();
 428   bind_promise(std::move(promise), std::move(future));
 429   return result;
 430 }
 431
 432 /** Producer side of a @ref simgrid::kernel::Future
 433  *
 434  *  A @ref Promise is connected to some `Future` and can be used to
 435  *  set its result.
 436  *
 437  *  Similar to std::promise
 438  *
 439  *  <code>
 440  *  // Create a promise and a future:
 441  *  auto promise = std::make_shared<simgrid::kernel::Promise<T>>();
 442  *  auto future = promise->get_future();
 443  *
 444  *  simgrid::simix::Timer::set(date, [promise] {
 445  *    try {
 446  *      int value = compute_the_value();
 447  *      if (value < 0)
 448  *        throw std::logic_error("Bad value");
 449  *      // Whenever the operation is completed, we set the value
 450  *      // for the future:
 451  *      promise.set_value(value);
 452  *    }
 453  *    catch (...) {
 454  *      // If an error occured, we can set an exception which
 455  *      // will be throwed buy future.get():
 456  *      promise.set_exception(std::current_exception());
 457  *    }
 458  *  });
 459  *
 460  *  // Return the future to the caller:
 461  *  return future;
 462  *  </code>
 463  **/
 464 template<class T>
 465 class Promise {
 466 public:
 467   Promise() : state_(std::make_shared<FutureState<T>>()) {}
 468   explicit Promise(std::shared_ptr<FutureState<T>> state) : state_(std::move(state)) {}
 469
 470   // Move type
 471   Promise(Promise const&) = delete;
 472   Promise& operator=(Promise const&) = delete;
 473   Promise(Promise&& that) :
 474     state_(std::move(that.state_)), future_get_(that.future_get_)
 475   {
 476     that.future_get_ = false;
 477   }
 478
 479   Promise& operator=(Promise&& that)
 480   {
 481     this->state_ = std::move(that.state_);
 482     this->future_get_ = that.future_get_;
 483     that.future_get_ = false;
 484     return *this;
 485   }
 486   Future<T> get_future()
 487   {
 488     if (state_ == nullptr)
 489       throw std::future_error(std::future_errc::no_state);
 490     if (future_get_)
 491       throw std::future_error(std::future_errc::future_already_retrieved);
 492     future_get_ = true;
 493     return Future<T>(state_);
 494   }
 495   void set_value(T value)
 496   {
 497     if (state_ == nullptr)
 498       throw std::future_error(std::future_errc::no_state);
 499     state_->set_value(std::move(value));
 500   }
 501   void set_exception(std::exception_ptr exception)
 502   {
 503     if (state_ == nullptr)
 504       throw std::future_error(std::future_errc::no_state);
 505     state_->set_exception(std::move(exception));
 506   }
 507   ~Promise()
 508   {
 509     if (state_ && state_->get_status() == FutureStatus::not_ready)
 510       state_->set_exception(std::make_exception_ptr(
 511         std::future_error(std::future_errc::broken_promise)));
 512   }
 513
 514 private:
 515   std::shared_ptr<FutureState<T>> state_;
 516   bool future_get_ = false;
 517 };
 518
 519 template<>
 520 class Promise<void> {
 521 public:
 522   Promise() : state_(std::make_shared<FutureState<void>>()) {}
 523   explicit Promise(std::shared_ptr<FutureState<void>> state) : state_(std::move(state)) {}
 524   ~Promise()
 525   {
 526     if (state_ && state_->get_status() == FutureStatus::not_ready)
 527       state_->set_exception(std::make_exception_ptr(
 528         std::future_error(std::future_errc::broken_promise)));
 529   }
 530
 531   // Move type
 532   Promise(Promise const&) = delete;
 533   Promise& operator=(Promise const&) = delete;
 534   Promise(Promise&& that) :
 535     state_(std::move(that.state_)), future_get_(that.future_get_)
 536   {
 537     that.future_get_ = false;
 538   }
 539   Promise& operator=(Promise&& that)
 540   {
 541     this->state_ = std::move(that.state_);
 542     this->future_get_ = that.future_get_;
 543     that.future_get_ = false;
 544     return *this;
 545   }
 546
 547   Future<void> get_future()
 548   {
 549     if (state_ == nullptr)
 550       throw std::future_error(std::future_errc::no_state);
 551     if (future_get_)
 552       throw std::future_error(std::future_errc::future_already_retrieved);
 553     future_get_ = true;
 554     return Future<void>(state_);
 555   }
 556   void set_value()
 557   {
 558     if (state_ == nullptr)
 559       throw std::future_error(std::future_errc::no_state);
 560     state_->set_value();
 561   }
 562   void set_exception(std::exception_ptr exception)
 563   {
 564     if (state_ == nullptr)
 565       throw std::future_error(std::future_errc::no_state);
 566     state_->set_exception(std::move(exception));
 567   }
 568
 569 private:
 570   std::shared_ptr<FutureState<void>> state_;
 571   bool future_get_ = false;
 572 };
 573
 574 }
 575 }
 576
 577 #endif