1 /* Copyright (c) 2016-2019. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP
7 #define SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP
14 #include <xbt/sysdep.h>
16 #include <xbt/future.hpp>
17 #include <simgrid/kernel/future.hpp>
18 #include <simgrid/simix.h>
19 #include <simgrid/simix.hpp>
21 XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code);
26 XBT_PUBLIC void unblock(smx_actor_t process);
28 /** Execute some code in kernel mode and wakes up the actor when
29 * the result is available.
31 * It is given a callback which is executed in the SimGrid kernel and
32 * returns a `simgrid::kernel::Future<T>`. The kernel blocks the actor
33 * until the Future is ready and:
35 * - either returns the value wrapped in the future to the actor
37 * - or raises the exception stored in the future in the actor.
39 * This can be used to implement blocking calls without adding new simcalls.
40 * One downside of this approach is that we don't have any semantic on what
41 * the actor is waiting. This might be a problem for the model-checker and
42 * we'll have to devise a way to make it work.
44 * @param code Kernel code returning a `simgrid::kernel::Future<T>`
45 * @return Value of the kernel future
46 * @exception Exception from the kernel future
48 template <class F> auto kernel_sync(F code) -> decltype(code().get())
50 typedef decltype(code().get()) T;
51 if (SIMIX_is_maestro())
52 xbt_die("Can't execute blocking call in kernel mode");
54 smx_actor_t self = SIMIX_process_self();
55 simgrid::xbt::Result<T> result;
57 simcall_run_blocking([&result, self, &code]{
60 future.then_([&result, self](std::shared_ptr<simgrid::kernel::FutureState<T>>&& value) {
61 simgrid::xbt::set_promise(result, simgrid::kernel::Future<T>(value));
62 simgrid::simix::unblock(self);
66 result.set_exception(std::current_exception());
67 simgrid::simix::unblock(self);
73 /** A blocking (`wait()`-based) future for SIMIX processes */
77 // TODO, simgrid::simix::when_all - wait for all future to be ready (this one is simple!)
78 // TODO, simgrid::simix::when_any - wait for any future to be ready
82 Future() { /* Nothing to do*/}
83 explicit Future(simgrid::kernel::Future<T> future) : future_(std::move(future)) {}
85 bool valid() const { return future_.valid(); }
89 throw std::future_error(std::future_errc::no_state);
90 smx_actor_t self = SIMIX_process_self();
91 simgrid::xbt::Result<T> result;
92 simcall_run_blocking([this, &result, self]{
94 // When the kernel future is ready...
95 this->future_.then_([&result, self](std::shared_ptr<simgrid::kernel::FutureState<T>>&& value) {
96 // ... wake up the process with the result of the kernel future.
97 simgrid::xbt::set_promise(result, simgrid::kernel::Future<T>(value));
98 simgrid::simix::unblock(self);
102 result.set_exception(std::current_exception());
103 simgrid::simix::unblock(self);
108 bool is_ready() const
111 throw std::future_error(std::future_errc::no_state);
112 return future_.is_ready();
116 // The future is ready! We don't have to wait:
117 if (this->is_ready())
119 // The future is not ready. We have to delegate to the SimGrid kernel:
120 std::exception_ptr exception;
121 smx_actor_t self = SIMIX_process_self();
122 simcall_run_blocking([this, &exception, self]{
124 // When the kernel future is ready...
125 this->future_.then_([this, self](std::shared_ptr<simgrid::kernel::FutureState<T>>&& value) {
126 // ...store it the simix kernel and wake up.
127 this->future_ = std::move(simgrid::kernel::Future<T>(value));
128 simgrid::simix::unblock(self);
132 exception = std::current_exception();
133 simgrid::simix::unblock(self);
138 // We wrap an event-based kernel future:
139 simgrid::kernel::Future<T> future_;
142 /** Start some asynchronous work
144 * @param code SimGrid kernel code which returns a simgrid::kernel::Future
145 * @return Actor future
147 template <class F> auto kernel_async(F code) -> Future<decltype(code().get())>
149 typedef decltype(code().get()) T;
151 // Execute the code in the kernel and get the kernel future:
152 simgrid::kernel::Future<T> future = simgrid::simix::simcall(std::move(code));
154 // Wrap the kernel future in a actor future:
155 return simgrid::simix::Future<T>(std::move(future));