X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0a41f5d471ce7d2afcaf32a96e653c2ae397d7fb..f186888449310ed2ffeae9f6cf170cf40f1d17d1:/include/simgrid/simix/blocking_simcall.hpp

diff --git a/include/simgrid/simix/blocking_simcall.hpp b/include/simgrid/simix/blocking_simcall.hpp
index c89b2738f1..3a41904109 100644
--- a/include/simgrid/simix/blocking_simcall.hpp
+++ b/include/simgrid/simix/blocking_simcall.hpp
@@ -7,14 +7,13 @@
 #ifndef SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP
 #define SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP
 
-#include <iostream>
-
 #include <exception>
+#include <functional>
+#include <future>
+#include <utility>
 
 #include <xbt/sysdep.h>
 
-#include <future>
-
 #include <xbt/future.hpp>
 #include <simgrid/kernel/future.hpp>
 #include <simgrid/simix.h>
@@ -25,19 +24,22 @@ 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>`
@@ -51,13 +53,13 @@ auto kernelSync(F code) -> decltype(code().get())
   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) {
+      future.then_([&result, self](simgrid::kernel::Future<T> value) {
         simgrid::xbt::setPromise(result, value);
         simgrid::simix::unblock(self);
       });
@@ -71,6 +73,11 @@ auto kernelSync(F code) -> decltype(code().get())
 }
 
 /** A blocking (`wait()`-based) future for SIMIX processes */
+// 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 T>
 class Future {
 public:
@@ -82,12 +89,12 @@ public:
   {
     if (!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_([this, &result, self](simgrid::kernel::Future<T> value) {
           // ... wake up the process with the result of the kernel future.
           simgrid::xbt::setPromise(result, value);
           simgrid::simix::unblock(self);
@@ -108,14 +115,16 @@ public:
   }
   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();
+    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](simgrid::kernel::Future<T> value) {
           // ...store it the simix kernel and wake up.
           this->future_ = std::move(value);
           simgrid::simix::unblock(self);
@@ -127,8 +136,6 @@ public:
       }
     });
   }
-  // TODO, wait_for()
-  // TODO, wait_until()
 private:
   // We wrap an event-based kernel future:
   simgrid::kernel::Future<T> future_;
@@ -137,7 +144,7 @@ private:
 /** 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)
@@ -145,11 +152,11 @@ auto kernelAsync(F code)
 {
   typedef decltype(code().get()) T;
 
-  // Execute the code in the kernel and get the kernel simcall:
+  // Execute the code in the kernel and get the kernel future:
   simgrid::kernel::Future<T> future =
     simgrid::simix::kernelImmediate(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));
 }