include/simgrid/simix.hpp

   1 /* Copyright (c) 2007-2019. 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_HPP
   8 #define SIMGRID_SIMIX_HPP
   9
  10 #include <simgrid/simix.h>
  11 #include <xbt/functional.hpp>
  12 #include <xbt/future.hpp>
  13 #include <xbt/signal.hpp>
  14
  15 #include <boost/heap/fibonacci_heap.hpp>
  16 #include <string>
  17 #include <unordered_map>
  18
  19 XBT_PUBLIC void simcall_run_kernel(std::function<void()> const& code);
  20 XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code);
  21
  22 namespace simgrid {
  23 namespace simix {
  24
  25 /** Execute some code in kernel context on behalf of the user code.
  26  *
  27  * Every modification of the environment must be protected this way: every setter, constructor and similar.
  28  * Getters don't have to be protected this way.
  29  *
  30  * This allows deterministic parallel simulation without any locking, even if almost nobody uses parallel simulation in
  31  * SimGrid. More interestingly it makes every modification of the simulated world observable by the model-checker,
  32  * allowing the whole MC business.
  33  *
  34  * It is highly inspired from the syscalls in a regular operating system, allowing the user code to get some specific
  35  * code executed in the kernel context. But here, there is almost no security involved. Parameters get checked for
  36  * finitness but that's all. The main goal remain to ensure reproductible ordering of uncomparable events (in [parallel]
  37  * simulation) and observability of events (in model-checking).
  38  *
  39  * The code passed as argument is supposed to terminate at the exact same simulated timestamp.
  40  * Do not use it if your code may block waiting for a subsequent event, e.g. if you lock a mutex,
  41  * you may need to wait for that mutex to be unlocked by its current owner.
  42  * Potentially blocking simcall must be issued using simcall_blocking(), right below in this file.
  43  */
  44 template <class F> typename std::result_of<F()>::type simcall(F&& code)
  45 {
  46   // If we are in the maestro, we take the fast path and execute the
  47   // code directly without simcall mashalling/unmarshalling/dispatch:
  48   if (SIMIX_is_maestro())
  49     return std::forward<F>(code)();
  50
  51   // If we are in the application, pass the code to the maestro which
  52   // executes it for us and reports the result. We use a std::future which
  53   // conveniently handles the success/failure value for us.
  54   typedef typename std::result_of<F()>::type R;
  55   simgrid::xbt::Result<R> result;
  56   simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
  57   return result.get();
  58 }
  59
  60 /** Execute some code (that does not return immediately) in kernel context
  61  *
  62  * This is very similar to simcall() right above, but the calling actor will not get rescheduled until
  63  * actor->simcall_answer() is called explicitely.
  64  *
  65  * This is meant for blocking actions. For example, locking a mutex is a blocking simcall.
  66  * First it's a simcall because that's obviously a modification of the world. Then, that's a blocking simcall because if
  67  * the mutex happens not to be free, the actor is added to a queue of actors in the mutex. Every mutex->unlock() takes
  68  * the first actor from the queue, mark it as current owner of the mutex and call actor->simcall_answer() to mark that
  69  * this mutex is now unblocked and ready to run again. If the mutex is initially free, the calling actor is unblocked
  70  * right away with actor->simcall_answer() once the mutex is marked as locked.
  71  *
  72  * If your code never calls actor->simcall_answer() itself, the actor will never return from its simcall.
  73  */
  74 template <class F> typename std::result_of<F()>::type simcall_blocking(F&& code)
  75 {
  76   // If we are in the maestro, we take the fast path and execute the
  77   // code directly without simcall mashalling/unmarshalling/dispatch:
  78   if (SIMIX_is_maestro())
  79     return std::forward<F>(code)();
  80
  81   // If we are in the application, pass the code to the maestro which
  82   // executes it for us and reports the result. We use a std::future which
  83   // conveniently handles the success/failure value for us.
  84   typedef typename std::result_of<F()>::type R;
  85   simgrid::xbt::Result<R> result;
  86   simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
  87   return result.get();
  88 }
  89
  90 XBT_ATTRIB_DEPRECATED_v325("Please manifest if you actually need this function")
  91     XBT_PUBLIC const std::vector<smx_actor_t>& process_get_runnable();
  92
  93 // What's executed as SIMIX actor code:
  94 typedef std::function<void()> ActorCode;
  95
  96 // Create an ActorCode based on a std::string
  97 typedef std::function<ActorCode(std::vector<std::string> args)> ActorCodeFactory;
  98
  99 XBT_PUBLIC void register_function(const std::string& name, const ActorCodeFactory& factory);
 100
 101 typedef std::pair<double, Timer*> TimerQelt;
 102 static boost::heap::fibonacci_heap<TimerQelt, boost::heap::compare<xbt::HeapComparator<TimerQelt>>> simix_timers;
 103
 104 /** @brief Timer datatype */
 105 class Timer {
 106   double date = 0.0;
 107
 108 public:
 109   decltype(simix_timers)::handle_type handle_;
 110
 111   Timer(double date, simgrid::xbt::Task<void()>&& callback) : date(date), callback(std::move(callback)) {}
 112
 113   simgrid::xbt::Task<void()> callback;
 114   double get_date() { return date; }
 115   void remove();
 116
 117   template <class F> static inline Timer* set(double date, F callback)
 118   {
 119     return set(date, simgrid::xbt::Task<void()>(std::move(callback)));
 120   }
 121
 122   template <class R, class T>
 123   XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static inline Timer* set(double date,
 124                                                                                           R (*callback)(T*), T* arg)
 125   {
 126     return set(date, std::bind(callback, arg));
 127   }
 128
 129   XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static Timer* set(double date, void (*callback)(void*),
 130                                                                                    void* arg)
 131   {
 132     return set(date, std::bind(callback, arg));
 133   }
 134   static Timer* set(double date, simgrid::xbt::Task<void()>&& callback);
 135   static double next() { return simix_timers.empty() ? -1.0 : simix_timers.top().first; }
 136 };
 137
 138 } // namespace simix
 139 } // namespace simgrid
 140
 141 XBT_PUBLIC smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code,
 142                                               void* data, sg_host_t host,
 143                                               std::unordered_map<std::string, std::string>* properties);
 144
 145 XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::xbt::Timer::set") XBT_PUBLIC smx_timer_t
 146     SIMIX_timer_set(double date, simgrid::xbt::Task<void()>&& callback);
 147
 148 #endif