X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5c037db836667c8408d94daf61b893dd1efbabca..afa62e573131c8a346d4703b58037ee1ff80e69e:/include/simgrid/simix.hpp

diff --git a/include/simgrid/simix.hpp b/include/simgrid/simix.hpp
index 9f73275352..2b979d735d 100644
--- a/include/simgrid/simix.hpp
+++ b/include/simgrid/simix.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
+/* Copyright (c) 2007-2019. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -7,305 +7,142 @@
 #ifndef SIMGRID_SIMIX_HPP
 #define SIMGRID_SIMIX_HPP
 
-#include <cstddef>
+#include <simgrid/simix.h>
+#include <xbt/functional.hpp>
+#include <xbt/future.hpp>
+#include <xbt/signal.hpp>
 
-#include <exception>
+#include <boost/heap/fibonacci_heap.hpp>
 #include <string>
-#include <utility>
-#include <memory>
-#include <functional>
-#include <future>
-#include <type_traits>
-
-#include <xbt/function_types.h>
-#include <simgrid/simix.h>
+#include <unordered_map>
 
-XBT_PUBLIC(void) simcall_run_kernel(std::function<void()> const& code);
+XBT_PUBLIC void simcall_run_kernel(std::function<void()> const& code);
+XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code);
 
 namespace simgrid {
 namespace simix {
 
-/** Fulfill a promise by executing a given code */
-template<class R, class F>
-void fulfill_promise(std::promise<R>& promise, F&& code)
-{
-  try {
-    promise.set_value(std::forward<F>(code)());
-  }
-  catch(...) {
-    promise.set_exception(std::current_exception());
-  }
-}
-
-/** Fulfill a promise by executing a given code
+/** Execute some code in kernel context on behalf of the user code.
+ *
+ * Every modification of the environment must be protected this way: every setter, constructor and similar.
+ * Getters don't have to be protected this way.
+ *
+ * This allows deterministic parallel simulation without any locking, even if almost nobody uses parallel simulation in
+ * SimGrid. More interestingly it makes every modification of the simulated world observable by the model-checker,
+ * allowing the whole MC business.
  *
- *  This is a special version for `std::promise<void>` because the default
- *  version does not compile in this case.
+ * It is highly inspired from the syscalls in a regular operating system, allowing the user code to get some specific
+ * code executed in the kernel context. But here, there is almost no security involved. Parameters get checked for
+ * finitness but that's all. The main goal remain to ensure reproductible ordering of uncomparable events (in [parallel]
+ * simulation) and observability of events (in model-checking).
+ *
+ * The code passed as argument is supposed to terminate at the exact same simulated timestamp.
+ * Do not use it if your code may block waiting for a subsequent event, e.g. if you lock a mutex,
+ * 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>
-void fulfill_promise(std::promise<void>& promise, F&& code)
+template <class F> typename std::result_of<F()>::type simcall(F&& code)
 {
-  try {
-    std::forward<F>(code)();
-    promise.set_value();
-  }
-  catch(...) {
-    promise.set_exception(std::current_exception());
-  }
+  // If we are in the maestro, we take the fast path and execute the
+  // code directly without simcall mashalling/unmarshalling/dispatch:
+  if (SIMIX_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;
+  simgrid::xbt::Result<R> result;
+  simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
+  return result.get();
 }
 
-/** Execute some code in the kernel/maestro
+/** Execute some code (that does not return immediately) in kernel context
+ *
+ * This is very similar to simcall() right above, but the calling actor will not get rescheduled until
+ * actor->simcall_answer() is called explicitely.
+ *
+ * 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
+ * the first actor from the queue, mark it as current owner of the mutex and call actor->simcall_answer() to mark that
+ * this mutex is now unblocked and ready to run again. If the mutex is initially free, the calling actor is unblocked
+ * right away with actor->simcall_answer() once the mutex is marked as locked.
  *
- *  This can be used to enforce mutual exclusion with other simcall.
- *  More importantly, this enforces a deterministic/reproducible ordering
- *  of the operation with respect to other simcalls.
+ * If your code never calls actor->simcall_answer() itself, the actor will never return from its simcall.
  */
-template<class F>
-typename std::result_of<F()>::type kernel(F&& code)
+template <class F> typename std::result_of<F()>::type simcall_blocking(F&& code)
 {
   // If we are in the maestro, we take the fast path and execute the
   // code directly without simcall mashalling/unmarshalling/dispatch:
   if (SIMIX_is_maestro())
     return std::forward<F>(code)();
 
-  // If we are in the application, pass the code to the maestro which is
+  // 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;
-  std::promise<R> promise;
-  simcall_run_kernel([&]{
-    xbt_assert(SIMIX_is_maestro(), "Not in maestro");
-    fulfill_promise(promise, std::forward<F>(code));
-  });
-  return promise.get_future().get();
+  simgrid::xbt::Result<R> result;
+  simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
+  return result.get();
 }
 
-class args {
-private:
-  int argc_ = 0;
-  char** argv_ = nullptr;
-public:
+XBT_ATTRIB_DEPRECATED_v325("Please manifest if you actually need this function")
+    XBT_PUBLIC const std::vector<smx_actor_t>& process_get_runnable();
 
-  // Main constructors
-  args() {}
+// What's executed as SIMIX actor code:
+typedef std::function<void()> ActorCode;
 
-  void assign(int argc, const char*const* argv)
-  {
-    clear();
-    char** new_argv = xbt_new(char*,argc + 1);
-    for (int i = 0; i < argc; i++)
-      new_argv[i] = xbt_strdup(argv[i]);
-    new_argv[argc] = nullptr;
-    this->argc_ = argc;
-    this->argv_ = new_argv;
-  }
-  args(int argc, const char*const* argv)
-  {
-    this->assign(argc, argv);
-  }
+// Create an ActorCode based on a std::string
+typedef std::function<ActorCode(std::vector<std::string> args)> ActorCodeFactory;
 
-  char** to_argv() const
-  {
-    const int argc = argc_;
-    char** argv = xbt_new(char*, argc + 1);
-    for (int i=0; i< argc; i++)
-      argv[i] = xbt_strdup(argv_[i]);
-    argv[argc] = nullptr;
-    return argv;
-  }
+XBT_PUBLIC void register_function(const std::string& name, const ActorCodeFactory& factory);
 
-  // Free
-  void clear()
-  {
-    for (int i = 0; i < this->argc_; i++)
-      free(this->argv_[i]);
-    free(this->argv_);
-    this->argc_ = 0;
-    this->argv_ = nullptr;
-  }
-  ~args() { clear(); }
+typedef std::pair<double, Timer*> TimerQelt;
+static boost::heap::fibonacci_heap<TimerQelt, boost::heap::compare<xbt::HeapComparator<TimerQelt>>> simix_timers;
 
-  // Copy
-  args(args const& that)
-  {
-    this->assign(that.argc(), that.argv());
-  }
-  args& operator=(args const& that)
-  {
-    this->assign(that.argc(), that.argv());
-    return *this;
-  }
+/** @brief Timer datatype */
+class Timer {
+  double date = 0.0;
 
-  // Move:
-  args(args&& that) : argc_(that.argc_), argv_(that.argv_)
-  {
-    that.argc_ = 0;
-    that.argv_ = nullptr;
-  }
-  args& operator=(args&& that)
-  {
-    this->argc_ = that.argc_;
-    this->argv_ = that.argv_;
-    that.argc_ = 0;
-    that.argv_ = nullptr;
-    return *this;
-  }
-
-  int    argc()            const { return argc_; }
-  char** argv()                  { return argv_; }
-  const char*const* argv() const { return argv_; }
-  char* operator[](std::size_t i) { return argv_[i]; }
-};
-
-inline std::function<void()> wrap_main(
-  xbt_main_func_t code,  std::shared_ptr<simgrid::simix::args> args)
-{
-  if (code) {
-    return [=]() {
-      code(args->argc(), args->argv());
-    };
-  }
-  else return std::function<void()>();
-}
-
-inline
-std::function<void()> wrap_main(xbt_main_func_t code, simgrid::simix::args args)
-{
-  if (code)
-    return wrap_main(code, std::unique_ptr<simgrid::simix::args>(
-      new simgrid::simix::args(std::move(args))));
-  else return std::function<void()>();
-}
-
-inline
-std::function<void()> wrap_main(xbt_main_func_t code, int argc, const char*const* argv)
-{
-  return wrap_main(code, simgrid::simix::args(argc, argv));
-}
-
-class Context;
-class ContextFactory;
-
-XBT_PUBLIC_CLASS ContextFactory {
-private:
-  std::string name_;
 public:
+  decltype(simix_timers)::handle_type handle_;
 
-  ContextFactory(std::string name) : name_(std::move(name)) {}
-  virtual ~ContextFactory();
-  virtual Context* create_context(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_process_t process) = 0;
+  Timer(double date, simgrid::xbt::Task<void()>&& callback) : date(date), callback(std::move(callback)) {}
 
-  // Optional methods for attaching main() as a context:
+  simgrid::xbt::Task<void()> callback;
+  double get_date() { return date; }
+  void remove();
 
-  /** Creates a context from the current context of execution
-   *
-   *  This will not work on all implementation of `ContextFactory`.
-   */
-  virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_process_t process);
-  virtual Context* create_maestro(std::function<void()> code, smx_process_t process);
-
-  virtual void run_all() = 0;
-  virtual Context* self();
-  std::string const& name() const
-  {
-    return name_;
-  }
-private:
-  void declare_context(void* T, std::size_t size);
-protected:
-  template<class T, class... Args>
-  T* new_context(Args&&... args)
+  template <class F> static inline Timer* set(double date, F callback)
   {
-    T* context = new T(std::forward<Args>(args)...);
-    this->declare_context(context, sizeof(T));
-    return context;
+    return set(date, simgrid::xbt::Task<void()>(std::move(callback)));
   }
-};
 
-XBT_PUBLIC_CLASS Context {
-private:
-  std::function<void()> code_;
-  void_pfn_smxprocess_t cleanup_func_ = nullptr;
-  smx_process_t process_ = nullptr;
-public:
-  bool iwannadie;
-public:
-  Context(std::function<void()> code,
-          void_pfn_smxprocess_t cleanup_func,
-          smx_process_t process);
-  void operator()()
-  {
-    code_();
-  }
-  bool has_code() const
-  {
-    return (bool) code_;
-  }
-  smx_process_t process()
+  template <class R, class T>
+  XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static inline Timer* set(double date,
+                                                                                          R (*callback)(T*), T* arg)
   {
-    return this->process_;
+    return set(date, std::bind(callback, arg));
   }
-  void set_cleanup(void_pfn_smxprocess_t cleanup)
+
+  XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static Timer* set(double date, void (*callback)(void*),
+                                                                                   void* arg)
   {
-    cleanup_func_ = cleanup;
+    return set(date, std::bind(callback, arg));
   }
-
-  // Virtual methods
-  virtual ~Context();
-  virtual void stop();
-  virtual void suspend() = 0;
+  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_CLASS AttachContext : public Context {
-public:
-
-  AttachContext(std::function<void()> code,
-          void_pfn_smxprocess_t cleanup_func,
-          smx_process_t process)
-    : Context(std::move(code), cleanup_func, process)
-  {}
+} // namespace simix
+} // namespace simgrid
 
-  ~AttachContext();
-
-  /** Called by the context when it is ready to give control
-   *  to the maestro.
-   */
-  virtual void attach_start() = 0;
-
-  /** Called by the context when it has finished its job */
-  virtual void attach_stop() = 0;
-};
-
-XBT_PUBLIC(void) set_maestro(std::function<void()> code);
-XBT_PUBLIC(void) create_maestro(std::function<void()> code);
-
-}
-}
-
-/*
- * Type of function that creates a process.
- * The function must accept the following parameters:
- * void* process: the process created will be stored there
- * const char *name: a name for the object. It is for user-level information and can be NULL
- * xbt_main_func_t code: is a function describing the behavior of the process
- * void *data: data a pointer to any data one may want to attach to the new object.
- * sg_host_t host: the location where the new process is executed
- * int argc, char **argv: parameters passed to code
- * xbt_dict_t pros: properties
- */
-typedef smx_process_t (*smx_creation_func_t) (
-                                      /* name */ const char*,
-                                      /* code */ xbt_main_func_t,
-                                      /* userdata */ void*,
-                                      /* hostname */ const char*,
-                                      /* kill_time */ double,
-                                      simgrid::simix::args args,
-                                      /* props */ xbt_dict_t,
-                                      /* auto_restart */ int,
-                                      /* parent_process */ smx_process_t);
+XBT_PUBLIC smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code,
+                                              void* data, sg_host_t host,
+                                              std::unordered_map<std::string, std::string>* properties);
 
-extern "C"
-XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::xbt::Timer::set") XBT_PUBLIC smx_timer_t
+    SIMIX_timer_set(double date, simgrid::xbt::Task<void()>&& callback);
 
 #endif