Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
play with mpich3 cmake files
[simgrid.git] / include / simgrid / simix.hpp
index 0cdf6ea..fb3fd5a 100644 (file)
@@ -24,24 +24,28 @@ XBT_PUBLIC(void) simcall_run_kernel(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(code());
+    promise.set_value(std::forward<F>(code)());
   }
   catch(...) {
     promise.set_exception(std::current_exception());
   }
 }
 
-// special version for R=void because the previous code does not compile
-// in this case:
+/** 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)
 {
   try {
-    code();
+    std::forward<F>(code)();
     promise.set_value();
   }
   catch(...) {
@@ -49,21 +53,95 @@ void fulfill_promise(std::promise<void>& promise, F&& code)
   }
 }
 
+/** Execute some code in the kernel/maestro
+ *
+ *  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.
+ */
 template<class F>
 typename std::result_of<F()>::type kernel(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
+  // 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([&]{
-    fulfill_promise(promise, code);
+    xbt_assert(SIMIX_is_maestro(), "Not in maestro");
+    fulfill_promise(promise, 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()>();
+}
+
 class Context;
 class ContextFactory;
 
-class ContextFactory {
+XBT_PUBLIC_CLASS ContextFactory {
 private:
   std::string name_;
 public:
@@ -72,6 +150,16 @@ public:
   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
@@ -90,7 +178,7 @@ protected:
   }
 };
 
-class Context {
+XBT_PUBLIC_CLASS Context {
 private:
   std::function<void()> code_;
   void_pfn_smxprocess_t cleanup_func_ = nullptr;
@@ -124,7 +212,30 @@ public:
   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);
+
 }
 }
 
-#endif
\ No newline at end of file
+#endif