Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
gosh, so much cruft in this code
[simgrid.git] / include / simgrid / simix.hpp
index c28bf8b..b6b9a1c 100644 (file)
@@ -9,51 +9,46 @@
 
 #include <cstddef>
 
-#include <exception>
 #include <string>
 #include <utility>
 #include <memory>
 #include <functional>
-#include <future>
-#include <type_traits>
 
 #include <xbt/function_types.h>
+#include <xbt/future.hpp>
+#include <xbt/functional.hpp>
+#include <xbt/signal.hpp>
+
 #include <simgrid/simix.h>
 
 XBT_PUBLIC(void) simcall_run_kernel(std::function<void()> const& code);
 
-namespace simgrid {
-namespace simix {
+/** Execute some code in the kernel and block
+ *
+ * run_blocking() is a generic blocking simcall. It is given a callback
+ * which is executed immediately in the SimGrid kernel. The callback is
+ * responsible for setting the suitable logic for waking up the process
+ * when needed.
+ *
+ * @ref simix::kernelSync() is a higher level wrapper for this.
+ */
+XBT_PUBLIC(void) simcall_run_blocking(std::function<void()> const& code);
 
-/** Fulfill a promise by executing a given code */
-template<class R, class F>
-void fulfill_promise(std::promise<R>& promise, F&& code)
+template<class F> inline
+void simcall_run_kernel(F& f)
 {
-  try {
-    promise.set_value(std::forward<F>(code)());
-  }
-  catch(...) {
-    promise.set_exception(std::current_exception());
-  }
+  simcall_run_kernel(std::function<void()>(std::ref(f)));
 }
-
-/** Fulfill a promise by executing a given code
- *
- *  This is a special version for `std::promise<void>` because the default
- *  version does not compile in this case.
- */
-template<class F>
-void fulfill_promise(std::promise<void>& promise, F&& code)
+template<class F> inline
+void simcall_run_blocking(F& f)
 {
-  try {
-    std::forward<F>(code)();
-    promise.set_value();
-  }
-  catch(...) {
-    promise.set_exception(std::current_exception());
-  }
+  simcall_run_blocking(std::function<void()>(std::ref(f)));
 }
 
+namespace simgrid {
+
+namespace simix {
+
 /** Execute some code in the kernel/maestro
  *
  *  This can be used to enforce mutual exclusion with other simcall.
@@ -61,213 +56,89 @@ void fulfill_promise(std::promise<void>& promise, F&& code)
  *  of the operation with respect to other simcalls.
  */
 template<class F>
-typename std::result_of<F()>::type kernel(F&& code)
+typename std::result_of<F()>::type kernelImmediate(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;
+  simgrid::xbt::Result<R> result;
   simcall_run_kernel([&]{
     xbt_assert(SIMIX_is_maestro(), "Not in maestro");
-    fulfill_promise(promise, std::forward<F>(code));
+    simgrid::xbt::fulfillPromise(result, std::forward<F>(code));
   });
-  return promise.get_future().get();
+  return result.get();
 }
 
-class args {
-private:
-  int argc_ = 0;
-  char** argv_ = nullptr;
-public:
-
-  // Main constructors
-  args() {}
-
-  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);
-  }
 
-  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) set_maestro(std::function<void()> code);
+XBT_PUBLIC(void) create_maestro(std::function<void()> code);
 
-  // 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(); }
+// What's executed as SIMIX actor code:
+typedef std::function<void()> ActorCode;
 
-  // Copy
-  args(args const& that)
-  {
-    this->assign(that.argc(), that.argv());
-  }
-  args& operator=(args const& that)
-  {
-    this->assign(that.argc(), that.argv());
-    return *this;
-  }
+// Create ActorCode based on argv:
+typedef std::function<ActorCode(std::vector<std::string> args)> ActorCodeFactory;
 
-  // 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;
-  }
+XBT_PUBLIC(void) registerFunction(const char* name, ActorCodeFactory factory);
 
-  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]; }
-};
+/** These functions will be called when we detect a deadlock: any remaining process is locked on an action
+ *
+ * If these functions manage to unlock some of the processes, then the deadlock will be avoided.
+ */
+extern simgrid::xbt::signal<void()> onDeadlock;
+}
+}
 
-inline
-std::function<void()> wrap_main(xbt_main_func_t code, int argc, const char*const* argv)
+/*
+ * 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_actor_t (*smx_creation_func_t) (
+                                      /* name */ const char*,
+                                      std::function<void()> code,
+                                      /* userdata */ void*,
+                                      /* hostname */ sg_host_t,
+                                      /* kill_time */ double,
+                                      /* props */ xbt_dict_t,
+                                      /* auto_restart */ int,
+                                      /* parent_process */ smx_actor_t);
+
+extern "C"
+XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
+
+XBT_PUBLIC(smx_actor_t) simcall_process_create(const char *name,
+                                          std::function<void()> code,
+                                          void *data,
+                                          sg_host_t host,
+                                          double kill_time,
+                                          xbt_dict_t properties,
+                                          int auto_restart);
+
+XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, simgrid::xbt::Task<void()> callback);
+
+template<class F> inline
+smx_timer_t SIMIX_timer_set(double date, F callback)
 {
-  if (code) {
-    auto arg = std::make_shared<simgrid::simix::args>(argc, argv);
-    return [=]() {
-      code(arg->argc(), arg->argv());
-    };
-  }
-  // TODO, we should free argv
-  else return std::function<void()>();
+  return SIMIX_timer_set(date, simgrid::xbt::Task<void()>(std::move(callback)));
 }
 
-class Context;
-class ContextFactory;
-
-XBT_PUBLIC_CLASS ContextFactory {
-private:
-  std::string name_;
-public:
-
-  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;
-
-  // Optional methods for attaching main() as a context:
-
-  /** 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)
-  {
-    T* context = new T(std::forward<Args>(args)...);
-    this->declare_context(context, sizeof(T));
-    return context;
-  }
-};
-
-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()
-  {
-    return this->process_;
-  }
-  void set_cleanup(void_pfn_smxprocess_t cleanup)
-  {
-    cleanup_func_ = cleanup;
-  }
-
-  // Virtual methods
-  virtual ~Context();
-  virtual void stop();
-  virtual void suspend() = 0;
-};
-
-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)
-  {}
-
-  ~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);
-
-}
+template<class R, class T> inline
+smx_timer_t SIMIX_timer_set(double date, R(*callback)(T*), T* arg)
+{
+  return SIMIX_timer_set(date, [=](){ callback(arg); });
 }
 
 #endif