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 must 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 /** Result of some (probably) asynchronous operation in the SimGrid kernel
 223  *
 224  * @ref simgrid::simix::Future and @ref simgrid::simix::Future provide an
 225  * abstration for asynchronous stuff happening in the SimGrid kernel. They
 226  * are based on C++1z futures.
 227  *
 228  * The future represents a value which will be available at some point when this
 229  * asynchronous operaiont is finished. Alternatively, if this operations fails,
 230  * the result of the operation might be an exception.
 231  *
 232  *  As the operation is possibly no terminated yet, we cannot get the result
 233  *  yet. Moreover, as we cannot block in the SimGrid kernel we cannot wait for
 234  *  it. However, we can attach some code/callback/continuation which will be
 235  *  executed when the operation terminates.
 236  *
 237  *  Example of the API (`simgrid::kernel::createProcess` does not exist):
 238  *  <pre>
 239  *  // Create a new process using the Worker code, this process returns
 240  *  // a std::string:
 241  *  simgrid::kernel::Future<std::string> future =
 242  *     simgrid::kernel::createProcess("worker42", host, Worker(42));
 243  *  // At this point, we just created the process so the result is not available.
 244  *  // However, we can attach some work do be done with this result:
 245  *  future.then([](simgrid::kernel::Future<std::string> result) {
 246  *    // This code is called when the operation is completed so the result is
 247  *    // available:
 248  *    try {
 249  *      // Try to get value, this might throw an exception if the operation
 250  *      // failed (such as an exception throwed by the worker process):
 251  *      std::string value = result.get();
 252  *      XBT_INFO("Value: %s", value.c_str());
 253  *    }
 254  *    catch(std::exception& e) {
 255  *      // This is an exception from the asynchronous operation:
 256  *      XBT_INFO("Error: %e", e.what());
 257  *    }
 258  *  );
 259  *  </pre>
 260  *
 261  *  This is based on C++1z std::future but with some differences:
 262  *
 263  *  * there is no thread synchronization (atomic, mutex, condition variable,
 264  *    etc.) because everything happens in the SimGrid event loop;
 265  *
 266  *  * it is purely asynchronous, you are expected to use `.then()`;
 267  *
 268  *  * inside the `.then()`, `.get()` can be used;
 269  *
 270  *  * `.get()` can only be used when `.is_ready()` (as everything happens in
 271  *     a single-thread, the future would be guaranted to deadlock if `.get()`
 272  *     is called when the future is not ready);
 273  *
 274  *  * there is no future chaining support for now (`.then().then()`);
 275  *
 276  *  * there is no sharing (`shared_future`) for now.
 277  */
 278 template<class T>
 279 class Future {
 280 public:
 281   Future() = default;
 282   explicit Future(std::shared_ptr<FutureState<T>> state) : state_(std::move(state)) {}
 283   ~Future() = default;
 284
 285   // Move type:
 286   Future(Future&) = delete;
 287   Future& operator=(Future&) = delete;
 288   Future(Future&& that) : state_(std::move(that.state_)) {}
 289   Future& operator=(Future&& that)
 290   {
 291     state_ = std::move(that.state_);
 292     return *this;
 293   }
 294
 295   /** Whether the future is valid:.
 296    *
 297    *  A future which as been used (`.then` of `.get`) becomes invalid.
 298    *
 299    *  We can use `.then` on a valid future.
 300    */
 301   bool valid() const
 302   {
 303     return state_ != nullptr;
 304   }
 305
 306   /** Whether the future is ready
 307    *
 308    *  A future is ready when it has an associated value or exception.
 309    *
 310    *  We can use `.get()` on ready futures.
 311    **/
 312   bool is_ready() const
 313   {
 314     return state_ != nullptr && state_->is_ready();
 315   }
 316
 317   /** Attach a continuation to this future
 318    *
 319    *  This is like .then() but avoid the creation of a new future.
 320    */
 321   template<class F>
 322   void then_(F continuation)
 323   {
 324     if (state_ == nullptr)
 325       throw std::future_error(std::future_errc::no_state);
 326     // Give shared-ownership to the continuation:
 327     auto state = std::move(state_);
 328     state->set_continuation(simgrid::xbt::make_task(std::move(continuation), state));
 329   }
 330
 331   /** Attach a continuation to this future
 332    *
 333    *  This version never does future unwrapping.
 334    */
 335   template <class F> auto then_no_unwrap(F continuation) -> Future<decltype(continuation(std::move(*this)))>
 336   {
 337     typedef decltype(continuation(std::move(*this))) R;
 338     if (state_ == nullptr)
 339       throw std::future_error(std::future_errc::no_state);
 340     auto state = std::move(state_);
 341     // Create a new future...
 342     Promise<R> promise;
 343     Future<R> future = promise.get_future();
 344     // ...and when the current future is ready...
 345     state->set_continuation(simgrid::xbt::make_task(
 346         [](Promise<R> promise, std::shared_ptr<FutureState<T>> state, F continuation) {
 347           // ...set the new future value by running the continuation.
 348           Future<T> future(std::move(state));
 349           simgrid::xbt::fulfill_promise(promise, [&continuation, &future] { return continuation(std::move(future)); });
 350         },
 351         std::move(promise), state, std::move(continuation)));
 352     return future;
 353   }
 354
 355   /** Attach a continuation to this future
 356    *
 357    *  The future must be valid in order to make this call.
 358    *  The continuation is executed when the future becomes ready.
 359    *  The future becomes invalid after this call.
 360    *
 361    * @param continuation This function is called with a ready future
 362    *                     the future is ready
 363    * @exception std::future_error no state is associated with the future
 364    */
 365   template <class F>
 366   auto then(F continuation) -> typename std::enable_if<not is_future<decltype(continuation(std::move(*this)))>::value,
 367                                                        Future<decltype(continuation(std::move(*this)))>>::type
 368   {
 369     return this->then_no_unwrap(std::move(continuation));
 370   }
 371
 372   /** Attach a continuation to this future (future chaining) */
 373   template<class F>
 374   auto then(F continuation)
 375   -> typename std::enable_if<
 376        is_future<decltype(continuation(std::move(*this)))>::value,
 377        decltype(continuation(std::move(*this)))
 378      >::type
 379   {
 380     return unwrap_future(this->then_no_unwrap(std::move(continuation)));
 381   }
 382
 383   /** Get the value from the future
 384    *
 385    *  The future must be valid and ready in order to make this call.
 386    *  std::future blocks when the future is not ready but we are
 387    *  completely single-threaded so blocking would be a deadlock.
 388    *  After the call, the future becomes invalid.
 389    *
 390    *  @return                      value of the future
 391    *  @exception any               Exception from the future
 392    *  @exception std::future_error no state is associated with the future
 393    */
 394   T get()
 395   {
 396     if (state_ == nullptr)
 397       throw std::future_error(std::future_errc::no_state);
 398     std::shared_ptr<FutureState<T>> state = std::move(state_);
 399     return state->get();
 400   }
 401
 402 private:
 403   std::shared_ptr<FutureState<T>> state_;
 404 };
 405
 406 template <class T> Future<T> unwrap_future(Future<Future<T>> future)
 407 {
 408   Promise<T> promise;
 409   Future<T> result = promise.get_future();
 410   bind_promise(std::move(promise), std::move(future));
 411   return result;
 412 }
 413
 414 /** Producer side of a @ref simgrid::kernel::Future
 415  *
 416  *  A @ref Promise is connected to some `Future` and can be used to
 417  *  set its result.
 418  *
 419  *  Similar to std::promise
 420  *
 421  *  <code>
 422  *  // Create a promise and a future:
 423  *  auto promise = std::make_shared<simgrid::kernel::Promise<T>>();
 424  *  auto future = promise->get_future();
 425  *
 426  *  simgrid::simix::Timer::set(date, [promise] {
 427  *    try {
 428  *      int value = compute_the_value();
 429  *      if (value < 0)
 430  *        throw std::logic_error("Bad value");
 431  *      // Whenever the operation is completed, we set the value
 432  *      // for the future:
 433  *      promise.set_value(value);
 434  *    }
 435  *    catch (...) {
 436  *      // If an error occured, we can set an exception which
 437  *      // will be throwed buy future.get():
 438  *      promise.set_exception(std::current_exception());
 439  *    }
 440  *  });
 441  *
 442  *  // Return the future to the caller:
 443  *  return future;
 444  *  </code>
 445  **/
 446 template<class T>
 447 class Promise {
 448 public:
 449   Promise() : state_(std::make_shared<FutureState<T>>()) {}
 450   explicit Promise(std::shared_ptr<FutureState<T>> state) : state_(std::move(state)) {}
 451
 452   // Move type
 453   Promise(Promise const&) = delete;
 454   Promise& operator=(Promise const&) = delete;
 455   Promise(Promise&& that) :
 456     state_(std::move(that.state_)), future_get_(that.future_get_)
 457   {
 458     that.future_get_ = false;
 459   }
 460
 461   Promise& operator=(Promise&& that)
 462   {
 463     this->state_ = std::move(that.state_);
 464     this->future_get_ = that.future_get_;
 465     that.future_get_ = false;
 466     return *this;
 467   }
 468   Future<T> get_future()
 469   {
 470     if (state_ == nullptr)
 471       throw std::future_error(std::future_errc::no_state);
 472     if (future_get_)
 473       throw std::future_error(std::future_errc::future_already_retrieved);
 474     future_get_ = true;
 475     return Future<T>(state_);
 476   }
 477   void set_value(T value)
 478   {
 479     if (state_ == nullptr)
 480       throw std::future_error(std::future_errc::no_state);
 481     state_->set_value(std::move(value));
 482   }
 483   void set_exception(std::exception_ptr exception)
 484   {
 485     if (state_ == nullptr)
 486       throw std::future_error(std::future_errc::no_state);
 487     state_->set_exception(std::move(exception));
 488   }
 489   ~Promise()
 490   {
 491     if (state_ && state_->get_status() == FutureStatus::not_ready)
 492       state_->set_exception(std::make_exception_ptr(
 493         std::future_error(std::future_errc::broken_promise)));
 494   }
 495
 496 private:
 497   std::shared_ptr<FutureState<T>> state_;
 498   bool future_get_ = false;
 499 };
 500
 501 template<>
 502 class Promise<void> {
 503 public:
 504   Promise() : state_(std::make_shared<FutureState<void>>()) {}
 505   explicit Promise(std::shared_ptr<FutureState<void>> state) : state_(std::move(state)) {}
 506   ~Promise()
 507   {
 508     if (state_ && state_->get_status() == FutureStatus::not_ready)
 509       state_->set_exception(std::make_exception_ptr(
 510         std::future_error(std::future_errc::broken_promise)));
 511   }
 512
 513   // Move type
 514   Promise(Promise const&) = delete;
 515   Promise& operator=(Promise const&) = delete;
 516   Promise(Promise&& that) :
 517     state_(std::move(that.state_)), future_get_(that.future_get_)
 518   {
 519     that.future_get_ = false;
 520   }
 521   Promise& operator=(Promise&& that)
 522   {
 523     this->state_ = std::move(that.state_);
 524     this->future_get_ = that.future_get_;
 525     that.future_get_ = false;
 526     return *this;
 527   }
 528
 529   Future<void> get_future()
 530   {
 531     if (state_ == nullptr)
 532       throw std::future_error(std::future_errc::no_state);
 533     if (future_get_)
 534       throw std::future_error(std::future_errc::future_already_retrieved);
 535     future_get_ = true;
 536     return Future<void>(state_);
 537   }
 538   void set_value()
 539   {
 540     if (state_ == nullptr)
 541       throw std::future_error(std::future_errc::no_state);
 542     state_->set_value();
 543   }
 544   void set_exception(std::exception_ptr exception)
 545   {
 546     if (state_ == nullptr)
 547       throw std::future_error(std::future_errc::no_state);
 548     state_->set_exception(std::move(exception));
 549   }
 550
 551 private:
 552   std::shared_ptr<FutureState<void>> state_;
 553   bool future_get_ = false;
 554 };
 555
 556 }
 557 }
 558
 559 #endif