Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / include / simgrid / simix.hpp
index db2d157..c990263 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2020. The SimGrid Team.
+/* Copyright (c) 2007-2022. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -7,18 +7,18 @@
 #ifndef SIMGRID_SIMIX_HPP
 #define SIMGRID_SIMIX_HPP
 
+#include <simgrid/s4u/Actor.hpp>
 #include <simgrid/simix.h>
-#include <xbt/functional.hpp>
-#include <xbt/future.hpp>
+#include <xbt/promise.hpp>
 #include <xbt/signal.hpp>
-#include <xbt/utility.hpp>
 
-#include <boost/heap/fibonacci_heap.hpp>
 #include <string>
 #include <unordered_map>
 
-XBT_PUBLIC void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t);
-XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t);
+XBT_PUBLIC void simcall_run_kernel(std::function<void()> const& code,
+                                   simgrid::kernel::actor::SimcallObserver* observer);
+XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code,
+                                     simgrid::kernel::actor::SimcallObserver* observer);
 
 namespace simgrid {
 namespace kernel {
@@ -43,19 +43,19 @@ namespace actor {
  * you may need to wait for that mutex to be unlocked by its current owner.
  * Potentially blocking simcall must be issued using simcall_blocking(), right below in this file.
  */
-template <class F> typename std::result_of<F()>::type simcall(F&& code, mc::SimcallInspector* t = nullptr)
+template <class F> typename std::result_of_t<F()> simcall(F&& code, SimcallObserver* observer = nullptr)
 {
   // If we are in the maestro, we take the fast path and execute the
   // code directly without simcall marshalling/unmarshalling/dispatch:
-  if (SIMIX_is_maestro())
+  if (s4u::Actor::is_maestro())
     return std::forward<F>(code)();
 
   // If we are in the application, pass the code to the maestro which
   // executes it for us and reports the result. We use a std::future which
   // conveniently handles the success/failure value for us.
-  typedef typename std::result_of<F()>::type R;
+  using R = typename std::result_of_t<F()>;
   simgrid::xbt::Result<R> result;
-  simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); }, t);
+  simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); }, observer);
   return result.get();
 }
 
@@ -64,9 +64,6 @@ template <class F> typename std::result_of<F()>::type simcall(F&& code, mc::Simc
  * This is very similar to simcall() right above, but the calling actor will not get rescheduled until
  * actor->simcall_answer() is called explicitly.
  *
- * Since the return value does not come from the lambda directly, its type cannot be guessed automatically and must
- * be provided as template parameter.
- *
  * This is meant for blocking actions. For example, locking a mutex is a blocking simcall.
  * First it's a simcall because that's obviously a modification of the world. Then, that's a blocking simcall because if
  * the mutex happens not to be free, the actor is added to a queue of actors in the mutex. Every mutex->unlock() takes
@@ -75,52 +72,32 @@ template <class F> typename std::result_of<F()>::type simcall(F&& code, mc::Simc
  * right away with actor->simcall_answer() once the mutex is marked as locked.
  *
  * If your code never calls actor->simcall_answer() itself, the actor will never return from its simcall.
+ *
+ * The return value is obtained from observer->get_result() if it exists. Otherwise void is returned.
  */
-template <class R, class F> R simcall_blocking(F&& code, mc::SimcallInspector* t = nullptr)
+template <class F> void simcall_blocking(F&& code, SimcallObserver* observer = nullptr)
 {
-  // If we are in the maestro, we take the fast path and execute the
-  // code directly without simcall marshalling/unmarshalling/dispatch:
-  if (SIMIX_is_maestro())
-    return std::forward<F>(code)();
+  xbt_assert(not s4u::Actor::is_maestro(), "Cannot execute blocking call in kernel mode");
 
-  // If we are in the application, pass the code to the maestro which
-  // executes it for us and reports the result. We use a std::future which
+  // Pass the code to the maestro which executes it for us and reports the result. We use a std::future which
   // conveniently handles the success/failure value for us.
-  simgrid::xbt::Result<R> result;
-  simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); }, t);
-  return result.get();
+  simgrid::xbt::Result<void> result;
+  simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); }, observer);
+  result.get(); // rethrow stored exception if any
+}
+
+template <class F, class Observer>
+auto simcall_blocking(F&& code, Observer* observer) -> decltype(observer->get_result())
+{
+  simcall_blocking(std::forward<F>(code), static_cast<SimcallObserver*>(observer));
+  return observer->get_result();
 }
 } // namespace actor
 } // namespace kernel
-} // namespace simgrid
-namespace simgrid {
-namespace simix {
-
-
-typedef std::pair<double, Timer*> TimerQelt;
-static boost::heap::fibonacci_heap<TimerQelt, boost::heap::compare<xbt::HeapComparator<TimerQelt>>> simix_timers;
 
-/** @brief Timer datatype */
-class Timer {
-  double date = 0.0;
-
-public:
-  decltype(simix_timers)::handle_type handle_;
-
-  Timer(double date, simgrid::xbt::Task<void()>&& callback) : date(date), callback(std::move(callback)) {}
-
-  simgrid::xbt::Task<void()> callback;
-  double get_date() const { return date; }
-  void remove();
-
-  template <class F> static inline Timer* set(double date, F callback)
-  {
-    return set(date, simgrid::xbt::Task<void()>(std::move(callback)));
-  }
+namespace simix {
 
-  static Timer* set(double date, simgrid::xbt::Task<void()>&& callback);
-  static double next() { return simix_timers.empty() ? -1.0 : simix_timers.top().first; }
-};
+XBT_PUBLIC void unblock(smx_actor_t process);
 
 } // namespace simix
 } // namespace simgrid