-/* Copyright (c) 2016. The SimGrid Team.
+/* Copyright (c) 2016-2018. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
#include <simgrid/simix.h>
#include <simgrid/simix.hpp>
-XBT_PUBLIC(void) simcall_run_blocking(std::function<void()> const& code);
+XBT_PUBLIC void simcall_run_blocking(std::function<void()> 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<T>. 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<T>`. 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<T>`
* @return Value of the kernel future
* @exception Exception from the kernel future
*/
-template<class F>
-auto kernelSync(F code) -> decltype(code().get())
+template <class F> 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<T> result;
simcall_run_blocking([&result, self, &code]{
try {
auto future = code();
- future.then_([&result, self](simgrid::kernel::Future<T> value) {
- simgrid::xbt::setPromise(result, value);
+ future.then_([&result, self](std::shared_ptr<simgrid::kernel::FutureState<T>>&& value) {
+ simgrid::xbt::set_promise(result, simgrid::kernel::Future<T>(value));
simgrid::simix::unblock(self);
});
}
});
return result.get();
}
+template <class F>
+XBT_ATTRIB_DEPRECATED_v323("Please use simix::kernel_sync()") auto kernelSync(F code) -> decltype(code().get())
+{
+ return kernel_sync(code);
+}
/** A blocking (`wait()`-based) future for SIMIX processes */
// TODO, .wait_for()
template <class T>
class Future {
public:
- Future() {}
- Future(simgrid::kernel::Future<T> future) : future_(std::move(future)) {}
+ Future() { /* Nothing to do*/}
+ explicit Future(simgrid::kernel::Future<T> future) : future_(std::move(future)) {}
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<T> result;
simcall_run_blocking([this, &result, self]{
try {
// When the kernel future is ready...
- this->future_.then_([this, &result, self](simgrid::kernel::Future<T> value) {
+ this->future_.then_([&result, self](std::shared_ptr<simgrid::kernel::FutureState<T>>&& value) {
// ... wake up the process with the result of the kernel future.
- simgrid::xbt::setPromise(result, value);
+ simgrid::xbt::set_promise(result, simgrid::kernel::Future<T>(value));
simgrid::simix::unblock(self);
});
}
}
bool is_ready() const
{
- if (!valid())
+ if (not valid())
throw std::future_error(std::future_errc::no_state);
return future_.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();
+ 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](simgrid::kernel::Future<T> value) {
+ this->future_.then_([this, self](std::shared_ptr<simgrid::kernel::FutureState<T>>&& value) {
// ...store it the simix kernel and wake up.
- this->future_ = std::move(value);
+ this->future_ = std::move(simgrid::kernel::Future<T>(value));
simgrid::simix::unblock(self);
});
}
/** Start some asynchronous work
*
* @param code SimGrid kernel code which returns a simgrid::kernel::Future
- * @return User future
+ * @return Actor future
*/
-template<class F>
-auto kernelAsync(F code)
- -> Future<decltype(code().get())>
+template <class F> auto kernel_async(F code) -> Future<decltype(code().get())>
{
typedef decltype(code().get()) T;
- // Execute the code in the kernel and get the kernel simcall:
- simgrid::kernel::Future<T> future =
- simgrid::simix::kernelImmediate(std::move(code));
+ // Execute the code in the kernel and get the kernel future:
+ simgrid::kernel::Future<T> future = simgrid::simix::simcall(std::move(code));
- // Wrap tyhe kernel simcall in a user simcall:
+ // Wrap the kernel future in a actor future:
return simgrid::simix::Future<T>(std::move(future));
}
-
+template <class F>
+XBT_ATTRIB_DEPRECATED_v323("Please use simix::kernel_sync()") auto kernelAsync(F code) -> Future<decltype(code().get())>
+{
+ return kernel_async(code);
+}
}
}
