1 /* Copyright (c) 2016-2019. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef SIMGRID_KERNEL_FUTURE_HPP
8 #define SIMGRID_KERNEL_FUTURE_HPP
14 #include <type_traits>
16 #include <boost/optional.hpp>
19 #include <xbt/functional.hpp>
20 #include <xbt/future.hpp>
25 // There are the public classes:
26 template<class T> class Future;
27 template<class T> class Promise;
29 // Those are implementation details:
30 enum class FutureStatus;
31 template<class T> class FutureState;
33 enum class FutureStatus {
40 struct is_future : std::false_type {};
42 struct is_future<Future<T>> : std::true_type {};
44 /** Bases stuff for all @ref simgrid::kernel::FutureState<T> */
45 class FutureStateBase {
48 FutureStateBase(FutureStateBase const&) = delete;
49 FutureStateBase& operator=(FutureStateBase const&) = delete;
51 XBT_PUBLIC void schedule(simgrid::xbt::Task<void()>&& job);
53 void set_exception(std::exception_ptr exception)
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);
62 void set_continuation(simgrid::xbt::Task<void()>&& continuation)
64 xbt_assert(not continuation_);
66 case FutureStatus::done:
67 // This is not supposed to happen if continuation is set
69 xbt_die("Set continuation on finished future");
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));
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);
86 FutureStatus get_status() const
93 return status_ == FutureStatus::ready;
97 FutureStateBase() = default;
98 ~FutureStateBase() = default;
100 /** Set the future as ready and trigger the continuation */
103 status_ = FutureStatus::ready;
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));
113 /** Set the future as done and raise an exception if any
115 * This does half the job of `.get()`.
119 if (status_ != FutureStatus::ready)
120 xbt_die("Deadlock: this future is not ready");
121 status_ = FutureStatus::done;
123 std::exception_ptr exception = std::move(exception_);
124 exception_ = nullptr;
125 std::rethrow_exception(std::move(exception));
130 FutureStatus status_ = FutureStatus::not_ready;
131 std::exception_ptr exception_;
132 simgrid::xbt::Task<void()> continuation_;
135 /** Shared state for future and promises
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.
143 class FutureState : public FutureStateBase {
146 void set_value(T value)
148 if (this->get_status() != FutureStatus::not_ready)
149 throw std::future_error(std::future_errc::promise_already_satisfied);
150 value_ = std::move(value);
157 xbt_assert(this->value_);
158 auto result = std::move(this->value_.get());
159 this->value_ = boost::optional<T>();
164 boost::optional<T> value_;
168 class FutureState<T&> : public FutureStateBase {
170 void set_value(T& value)
172 if (this->get_status() != FutureStatus::not_ready)
173 throw std::future_error(std::future_errc::promise_already_satisfied);
181 xbt_assert(this->value_);
192 class FutureState<void> : public FutureStateBase {
196 if (this->get_status() != FutureStatus::not_ready)
197 throw std::future_error(std::future_errc::promise_already_satisfied);
207 template <class T> void bind_promise(Promise<T>&& promise, Future<T> future)
209 class PromiseBinder {
211 explicit PromiseBinder(Promise<T>&& promise) : promise_(std::move(promise)) {}
212 void operator()(Future<T> future) { simgrid::xbt::set_promise(promise_, future); }
217 future.then_(PromiseBinder(std::move(promise)));
220 template <class T> Future<T> unwrap_future(Future<Future<T>> future);
222 /** Result of some (probably) asynchronous operation in the SimGrid kernel
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.
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.
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.
237 * Example of the API (`simgrid::kernel::createProcess` does not exist):
239 * // Create a new process using the Worker code, this process returns
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
249 * // Try to get value, this might throw an exception if the operation
250 * // failed (such as an exception thrown by the worker process):
251 * std::string value = result.get();
252 * XBT_INFO("Value: %s", value.c_str());
254 * catch(std::exception& e) {
255 * // This is an exception from the asynchronous operation:
256 * XBT_INFO("Error: %e", e.what());
261 * This is based on C++1z std::future but with some differences:
263 * * there is no thread synchronization (atomic, mutex, condition variable,
264 * etc.) because everything happens in the SimGrid event loop;
266 * * it is purely asynchronous, you are expected to use `.then()`;
268 * * inside the `.then()`, `.get()` can be used;
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);
274 * * there is no future chaining support for now (`.then().then()`);
276 * * there is no sharing (`shared_future`) for now.
282 explicit Future(std::shared_ptr<FutureState<T>> state) : state_(std::move(state)) {}
286 Future(Future&) = delete;
287 Future& operator=(Future&) = delete;
288 Future(Future&& that) : state_(std::move(that.state_)) {}
289 Future& operator=(Future&& that)
291 state_ = std::move(that.state_);
295 /** Whether the future is valid:.
297 * A future which as been used (`.then` of `.get`) becomes invalid.
299 * We can use `.then` on a valid future.
303 return state_ != nullptr;
306 /** Whether the future is ready
308 * A future is ready when it has an associated value or exception.
310 * We can use `.get()` on ready futures.
312 bool is_ready() const
314 return state_ != nullptr && state_->is_ready();
317 /** Attach a continuation to this future
319 * This is like .then() but avoid the creation of a new future.
322 void then_(F continuation)
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));
331 /** Attach a continuation to this future
333 * This version never does future unwrapping.
335 template <class F> auto then_no_unwrap(F continuation) -> Future<decltype(continuation(std::move(*this)))>
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...
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)); });
351 std::move(promise), state, std::move(continuation)));
355 /** Attach a continuation to this future
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.
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
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
369 return this->then_no_unwrap(std::move(continuation));
372 /** Attach a continuation to this future (future chaining) */
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)))
380 return unwrap_future(this->then_no_unwrap(std::move(continuation)));
383 /** Get the value from the future
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.
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
396 if (state_ == nullptr)
397 throw std::future_error(std::future_errc::no_state);
398 std::shared_ptr<FutureState<T>> state = std::move(state_);
403 std::shared_ptr<FutureState<T>> state_;
406 template <class T> Future<T> unwrap_future(Future<Future<T>> future)
409 Future<T> result = promise.get_future();
410 bind_promise(std::move(promise), std::move(future));
414 /** Producer side of a @ref simgrid::kernel::Future
416 * A @ref Promise is connected to some `Future` and can be used to
419 * Similar to std::promise
422 * // Create a promise and a future:
423 * auto promise = std::make_shared<simgrid::kernel::Promise<T>>();
424 * auto future = promise->get_future();
426 * simgrid::simix::Timer::set(date, [promise] {
428 * int value = compute_the_value();
430 * throw std::logic_error("Bad value");
431 * // Whenever the operation is completed, we set the value
433 * promise.set_value(value);
436 * // If an error occured, we can set an exception which
437 * // will be thrown by future.get():
438 * promise.set_exception(std::current_exception());
442 * // Return the future to the caller:
449 Promise() : state_(std::make_shared<FutureState<T>>()) {}
450 explicit Promise(std::shared_ptr<FutureState<T>> state) : state_(std::move(state)) {}
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_)
458 that.future_get_ = false;
461 Promise& operator=(Promise&& that)
463 this->state_ = std::move(that.state_);
464 this->future_get_ = that.future_get_;
465 that.future_get_ = false;
468 Future<T> get_future()
470 if (state_ == nullptr)
471 throw std::future_error(std::future_errc::no_state);
473 throw std::future_error(std::future_errc::future_already_retrieved);
475 return Future<T>(state_);
477 void set_value(T value)
479 if (state_ == nullptr)
480 throw std::future_error(std::future_errc::no_state);
481 state_->set_value(std::move(value));
483 void set_exception(std::exception_ptr exception)
485 if (state_ == nullptr)
486 throw std::future_error(std::future_errc::no_state);
487 state_->set_exception(std::move(exception));
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)));
497 std::shared_ptr<FutureState<T>> state_;
498 bool future_get_ = false;
502 class Promise<void> {
504 Promise() : state_(std::make_shared<FutureState<void>>()) {}
505 explicit Promise(std::shared_ptr<FutureState<void>> state) : state_(std::move(state)) {}
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)));
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_)
519 that.future_get_ = false;
521 Promise& operator=(Promise&& that)
523 this->state_ = std::move(that.state_);
524 this->future_get_ = that.future_get_;
525 that.future_get_ = false;
529 Future<void> get_future()
531 if (state_ == nullptr)
532 throw std::future_error(std::future_errc::no_state);
534 throw std::future_error(std::future_errc::future_already_retrieved);
536 return Future<void>(state_);
540 if (state_ == nullptr)
541 throw std::future_error(std::future_errc::no_state);
544 void set_exception(std::exception_ptr exception)
546 if (state_ == nullptr)
547 throw std::future_error(std::future_errc::no_state);
548 state_->set_exception(std::move(exception));
552 std::shared_ptr<FutureState<void>> state_;
553 bool future_get_ = false;