X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1e5e4a470ede08f4055218978210e6c6e7fb751a..dae3e1ff7494f78632ef7d90d97d0794d7e7bc1f:/include/simgrid/simix/blocking_simcall.hpp diff --git a/include/simgrid/simix/blocking_simcall.hpp b/include/simgrid/simix/blocking_simcall.hpp index 2e26f0a2ba..c95e63f09f 100644 --- a/include/simgrid/simix/blocking_simcall.hpp +++ b/include/simgrid/simix/blocking_simcall.hpp @@ -1,5 +1,4 @@ -/* Copyright (c) 2016. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2016-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -7,131 +6,138 @@ #ifndef SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP #define SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP -#include - #include +#include +#include +#include #include -#include - #include #include #include #include -XBT_PUBLIC(void) simcall_run_blocking(std::function const& code); - namespace simgrid { namespace simix { -XBT_PUBLIC(void) unblock(smx_process_t process); +XBT_PUBLIC void unblock(smx_actor_t process); -/** Execute some code in kernel mode and wakes up the process when +/** Execute some code in kernel mode and wakes up the actor when * the result is available. * - * It is given a callback which is executed in the kernel SimGrid and - * returns a simgrid::kernel::Future. The kernel blocks the process - * until the Future is ready and either the value wrapped in the future - * to the process or raises the exception stored in the Future in the process. + * It is given a callback which is executed in the SimGrid kernel and + * returns a `simgrid::kernel::Future`. The kernel blocks the actor + * until the Future is ready and: + * + * - either returns the value wrapped in the future to the actor + * + * - or raises the exception stored in the future in the actor. * * This can be used to implement blocking calls without adding new simcalls. * One downside of this approach is that we don't have any semantic on what - * the process is waiting. This might be a problem for the model-checker and + * the actor is waiting. This might be a problem for the model-checker and * we'll have to devise a way to make it work. * * @param code Kernel code returning a `simgrid::kernel::Future` * @return Value of the kernel future * @exception Exception from the kernel future */ -template -auto kernelSync(F code) -> decltype(code().get()) +template auto kernel_sync(F code) -> decltype(code().get()) { typedef decltype(code().get()) T; if (SIMIX_is_maestro()) xbt_die("Can't execute blocking call in kernel mode"); - smx_process_t self = SIMIX_process_self(); + smx_actor_t self = SIMIX_process_self(); simgrid::xbt::Result result; - simcall_run_blocking([&result, self, &code]{ - try { - auto future = code(); - future.then([&result, self](simgrid::kernel::Future value) { - simgrid::xbt::setPromise(result, value); - simgrid::simix::unblock(self); - }); - } - catch (...) { - result.set_exception(std::current_exception()); - simgrid::simix::unblock(self); - } - }); + simcall_run_blocking( + [&result, self, &code] { + try { + auto future = code(); + future.then_([&result, self](std::shared_ptr> value) { + simgrid::xbt::set_promise(result, simgrid::kernel::Future(std::move(value))); + simgrid::simix::unblock(self); + }); + } catch (...) { + result.set_exception(std::current_exception()); + simgrid::simix::unblock(self); + } + }, + nullptr); return result.get(); } /** A blocking (`wait()`-based) future for SIMIX processes */ -// TODO, .wait_for() -// TODO, .wait_until() +// TODO, .wait_for +// TODO, .wait_until // TODO, SharedFuture // TODO, simgrid::simix::when_all - wait for all future to be ready (this one is simple!) // TODO, simgrid::simix::when_any - wait for any future to be ready template class Future { public: - Future() {} - Future(simgrid::kernel::Future future) : future_(std::move(future)) {} + Future() = default; + explicit Future(simgrid::kernel::Future future) : future_(std::move(future)) {} + Future(Future&&) noexcept = default; + Future& operator=(Future&&) noexcept = default; bool valid() const { return future_.valid(); } T get() { - if (!valid()) + if (not valid()) throw std::future_error(std::future_errc::no_state); - smx_process_t self = SIMIX_process_self(); + smx_actor_t self = SIMIX_process_self(); simgrid::xbt::Result result; - simcall_run_blocking([this, &result, self]{ - try { - // When the kernel future is ready... - this->future_.then([this, &result, self](simgrid::kernel::Future value) { - // ... wake up the process with the result of the kernel future. - simgrid::xbt::setPromise(result, value); - simgrid::simix::unblock(self); - }); - } - catch (...) { - result.set_exception(std::current_exception()); - simgrid::simix::unblock(self); - } - }); + simcall_run_blocking( + [this, &result, self] { + try { + // When the kernel future is ready... + this->future_.then_([&result, self](std::shared_ptr> value) { + // ... wake up the process with the result of the kernel future. + simgrid::xbt::set_promise(result, simgrid::kernel::Future(std::move(value))); + simgrid::simix::unblock(self); + }); + } catch (...) { + result.set_exception(std::current_exception()); + simgrid::simix::unblock(self); + } + }, + nullptr); return result.get(); } bool is_ready() const { - if (!valid()) + if (not valid()) throw std::future_error(std::future_errc::no_state); return future_.is_ready(); } void wait() { - if (!valid()) - throw std::future_error(std::future_errc::no_state); + // The future is ready! We don't have to wait: + if (this->is_ready()) + return; + // The future is not ready. We have to delegate to the SimGrid kernel: std::exception_ptr exception; - smx_process_t self = SIMIX_process_self(); - simcall_run_blocking([this, &exception, self]{ - try { - // When the kernel future is ready... - this->future_.then([this, self](simgrid::kernel::Future value) { - // ...store it the simix kernel and wake up. - this->future_ = std::move(value); - simgrid::simix::unblock(self); - }); - } - catch (...) { - exception = std::current_exception(); - simgrid::simix::unblock(self); - } - }); + smx_actor_t self = SIMIX_process_self(); + simcall_run_blocking( + [this, &exception, self] { + try { + // When the kernel future is ready... + this->future_.then_([this, self](std::shared_ptr> value) { + // ...store it the simix kernel and wake up. + this->future_ = simgrid::kernel::Future(std::move(value)); + simgrid::simix::unblock(self); + }); + } catch (...) { + exception = std::current_exception(); + simgrid::simix::unblock(self); + } + }, + nullptr); } + private: // We wrap an event-based kernel future: simgrid::kernel::Future future_; @@ -140,22 +146,18 @@ private: /** Start some asynchronous work * * @param code SimGrid kernel code which returns a simgrid::kernel::Future - * @return User future + * @return Actor future */ -template -auto kernelAsync(F code) - -> Future +template auto kernel_async(F code) -> Future { typedef decltype(code().get()) T; - // Execute the code in the kernel and get the kernel simcall: - simgrid::kernel::Future future = - simgrid::simix::kernelImmediate(std::move(code)); + // Execute the code in the kernel and get the kernel future: + simgrid::kernel::Future future = simgrid::kernel::actor::simcall(std::move(code)); - // Wrap tyhe kernel simcall in a user simcall: + // Wrap the kernel future in an actor future: return simgrid::simix::Future(std::move(future)); } - } }