Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove xbt::args: use vector<string> instead
[simgrid.git] / include / simgrid / simix.hpp
index fb3fd5a..d08f865 100644 (file)
 #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 <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.
@@ -60,82 +55,23 @@ 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();
-}
-
-class args {
-private:
-  int argc_;
-  char** argv_;
-public:
-
-  // Main constructors
-  args() : argc_(0), argv_(nullptr) {}
-  args(int argc, char** argv) : argc_(argc), argv_(argv) {}
-
-  // 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(); }
-
-  // Copy
-  args(args const& that) = delete;
-  args& operator=(args const& that) = delete;
-
-  // 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, int argc, char **argv)
-{
-  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 result.get();
 }
 
 class Context;
@@ -146,7 +82,7 @@ private:
   std::string name_;
 public:
 
-  ContextFactory(std::string name) : name_(std::move(name)) {}
+  explicit 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;
@@ -221,7 +157,7 @@ public:
     : Context(std::move(code), cleanup_func, process)
   {}
 
-  ~AttachContext();
+  ~AttachContext() override;
 
   /** Called by the context when it is ready to give control
    *  to the maestro.
@@ -235,7 +171,61 @@ public:
 XBT_PUBLIC(void) set_maestro(std::function<void()> code);
 XBT_PUBLIC(void) create_maestro(std::function<void()> code);
 
+// What's executed as SIMIX actor code:
+typedef std::function<void()> ActorCode;
+
+// Create ActorCode based on argv:
+typedef std::function<ActorCode(std::vector<std::string> args)> ActorCodeFactory;
+
+XBT_PUBLIC(void) registerFunction(const char* name, ActorCodeFactory factory);
+
+}
 }
+
+/*
+ * 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*,
+                                      std::function<void()> code,
+                                      /* userdata */ void*,
+                                      /* hostname */ const char*,
+                                      /* kill_time */ double,
+                                      /* props */ xbt_dict_t,
+                                      /* auto_restart */ int,
+                                      /* parent_process */ smx_process_t);
+
+extern "C"
+XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
+
+XBT_PUBLIC(smx_process_t) simcall_process_create(const char *name,
+                                          std::function<void()> code,
+                                          void *data,
+                                          const char *hostname,
+                                          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
+XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, F callback)
+{
+  return SIMIX_timer_set(date, simgrid::xbt::Task<void()>(std::move(callback)));
+}
+
+template<class R, class T> inline
+XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, R(*callback)(T*), T* arg)
+{
+  return SIMIX_timer_set(date, [=](){ callback(arg); });
 }
 
 #endif