include/simgrid/simix/blocking_simcall.hpp

   1 /* Copyright (c) 2016. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #ifndef SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP
   8 #define SIMGRID_SIMIX_BLOCKING_SIMCALL_HPP
   9
  10 #include <iostream>
  11
  12 #include <exception>
  13
  14 #include <xbt/sysdep.h>
  15
  16 #include <future>
  17
  18 #include <xbt/future.hpp>
  19 #include <simgrid/kernel/future.hpp>
  20 #include <simgrid/simix.h>
  21 #include <simgrid/simix.hpp>
  22
  23 XBT_PUBLIC(void) simcall_run_blocking(std::function<void()> const& code);
  24
  25 namespace simgrid {
  26 namespace simix {
  27
  28 XBT_PUBLIC(void) unblock(smx_process_t process);
  29
  30 /** Execute some code in kernel mode and wakes up the process when
  31  *  the result is available.
  32  *
  33  * It is given a callback which is executed in the kernel SimGrid and
  34  * returns a simgrid::kernel::Future<T>. The kernel blocks the process
  35  * until the Future is ready and either the value wrapped in the future
  36  * to the process or raises the exception stored in the Future in the process.
  37  *
  38  * This can be used to implement blocking calls without adding new simcalls.
  39  * One downside of this approach is that we don't have any semantic on what
  40  * the process is waiting. This might be a problem for the model-checker and
  41  * we'll have to devise a way to make it work.
  42  *
  43  * @param     code Kernel code returning a `simgrid::kernel::Future<T>`
  44  * @return         Value of the kernel future
  45  * @exception      Exception from the kernel future
  46  */
  47 template<class F>
  48 auto kernelSync(F code) -> decltype(code().get())
  49 {
  50   typedef decltype(code().get()) T;
  51   if (SIMIX_is_maestro())
  52     xbt_die("Can't execute blocking call in kernel mode");
  53
  54   smx_process_t self = SIMIX_process_self();
  55   simgrid::xbt::Result<T> result;
  56
  57   simcall_run_blocking([&result, self, &code]{
  58     try {
  59       auto future = code();
  60       future.then([&result, self](simgrid::kernel::Future<T> value) {
  61         simgrid::xbt::setPromise(result, value);
  62         simgrid::simix::unblock(self);
  63       });
  64     }
  65     catch (...) {
  66       result.set_exception(std::current_exception());
  67       simgrid::simix::unblock(self);
  68     }
  69   });
  70   return result.get();
  71 }
  72
  73 /** A blocking (`wait()`-based) future for SIMIX processes */
  74 template <class T>
  75 class Future {
  76 public:
  77   Future() {}
  78   Future(simgrid::kernel::Future<T> future) : future_(std::move(future)) {}
  79
  80   bool valid() const { return future_.valid(); }
  81   T get()
  82   {
  83     if (!valid())
  84       throw std::future_error(std::future_errc::no_state);
  85     smx_process_t self = SIMIX_process_self();
  86     simgrid::xbt::Result<T> result;
  87     simcall_run_blocking([this, &result, self]{
  88       try {
  89         // When the kernel future is ready...
  90         this->future_.then([this, &result, self](simgrid::kernel::Future<T> value) {
  91           // ... wake up the process with the result of the kernel future.
  92           simgrid::xbt::setPromise(result, value);
  93           simgrid::simix::unblock(self);
  94         });
  95       }
  96       catch (...) {
  97         result.set_exception(std::current_exception());
  98         simgrid::simix::unblock(self);
  99       }
 100     });
 101     return result.get();
 102   }
 103   bool is_ready() const
 104   {
 105     if (!valid())
 106       throw std::future_error(std::future_errc::no_state);
 107     return future_.is_ready();
 108   }
 109   void wait()
 110   {
 111     if (!valid())
 112       throw std::future_error(std::future_errc::no_state);
 113     std::exception_ptr exception;
 114     smx_process_t self = SIMIX_process_self();
 115     simcall_run_blocking([this, &exception, self]{
 116       try {
 117         // When the kernel future is ready...
 118         this->future_.then([this, self](simgrid::kernel::Future<T> value) {
 119           // ...store it the simix kernel and wake up.
 120           this->future_ = std::move(value);
 121           simgrid::simix::unblock(self);
 122         });
 123       }
 124       catch (...) {
 125         exception = std::current_exception();
 126         simgrid::simix::unblock(self);
 127       }
 128     });
 129   }
 130   // TODO, wait_for()
 131   // TODO, wait_until()
 132 private:
 133   // We wrap an event-based kernel future:
 134   simgrid::kernel::Future<T> future_;
 135 };
 136
 137 /** Start some asynchronous work
 138  *
 139  *  @param code SimGrid kernel code which returns a simgrid::kernel::Future
 140  *  @return     User future
 141  */
 142 template<class F>
 143 auto kernelAsync(F code)
 144   -> Future<decltype(code().get())>
 145 {
 146   typedef decltype(code().get()) T;
 147
 148   // Execute the code in the kernel and get the kernel simcall:
 149   simgrid::kernel::Future<T> future =
 150     simgrid::simix::kernelImmediate(std::move(code));
 151
 152   // Wrap tyhe kernel simcall in a user simcall:
 153   return simgrid::simix::Future<T>(std::move(future));
 154 }
 155
 156 }
 157 }
 158
 159 #endif