X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f22a365751c586e7d4d9836824730685a30a485c..1cce0801abcad7c884f9e72ceda87e36d6635104:/include/simgrid/s4u/actor.hpp

diff --git a/include/simgrid/s4u/actor.hpp b/include/simgrid/s4u/actor.hpp
index 680bcd6d7d..4f3a1a9f5d 100644
--- a/include/simgrid/s4u/actor.hpp
+++ b/include/simgrid/s4u/actor.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,55 +6,219 @@
 #ifndef SIMGRID_S4U_ACTOR_HPP
 #define SIMGRID_S4U_ACTOR_HPP
 
+#include <atomic>
+#include <functional>
+#include <memory>
+#include <stdexcept>
+#include <type_traits>
+
 #include <xbt/base.h>
+#include <xbt/functional.hpp>
+
 #include <simgrid/simix.h>
 #include <simgrid/s4u/forward.hpp>
 
 namespace simgrid {
 namespace s4u {
 
-/** @brief Simulation Agent
- *
- * An actor may be defined as a code executing in a location (host).
- *
- * All actors should be started from the XML deployment file (using the @link{s4u::Engine::loadDeployment()}),
- * even if you can also start new actors directly.
- * Separating the deployment in the XML from the logic in the code is a good habit as it makes your simulation easier
- * to adapt to new settings.
+/** @ingroup s4u_api
+ * 
+ * An actor is an independent stream of execution in your distributed application.
  *
- * The code that you define for a given actor should be placed in the main method that is virtual.
- * For example, a Worker actor should be declared as follows:
- *
- * \verbatim
+ * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
+ * This is the only component in SimGrid that actually does something on its own, executing its own code. 
+ * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and schedule these activities.
+ * 
+ * An actor is located on a (simulated) host, but it can interact
+ * with the whole simulated platform.
+ * 
+ * The s4u::Actor API is strongly inspired from the C++11 threads.
+ * The <a href="http://en.cppreference.com/w/cpp/thread">documentation 
+ * of this standard</a> may help to understand the philosophy of the S4U
+ * Actors. 
+ * 
+ * @section s4u_actor_def Defining the skeleton of an Actor
+ * 
+ * %As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
+ * standard</a>, you can declare the code of your actor either as a
+ * pure function or as an object. It is very simple with functions:
+ * 
+ * @code{.cpp}
  * #include "s4u/actor.hpp"
- *
- * class Worker : simgrid::s4u::Actor {
- *
- *     int main(int argc, char **argv) {
- *    printf("Hello s4u");
- *    }
+ * 
+ * // Declare the code of your worker
+ * void worker() {
+ *   printf("Hello s4u");
+ *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
  * };
- * \endverbatim
+ * 
+ * // From your main or from another actor, create your actor on the host Jupiter
+ * // The following line actually creates a new actor, even if there is no "new". 
+ * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
+ * @endcode
+ * 
+ * But some people prefer to encapsulate their actors in classes and
+ * objects to save the actor state in a cleanly dedicated location.
+ * The syntax is slightly more complicated, but not much.
+ * 
+ * @code{.cpp}
+ * #include "s4u/actor.hpp"
+ * 
+ * // Declare the class representing your actors
+ * class Worker {
+ * public:
+ *   void operator()() { // Two pairs of () because this defines the method called ()
+ *     printf("Hello s4u");
+ *     simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
+ *   }
+ * };
+ * 
+ * // From your main or from another actor, create your actor. Note the () after Worker
+ * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
+ * @endcode
+ * 
+ * @section s4u_actor_flesh Fleshing your actor
+ * 
+ * The body of your actor can use the functions of the
+ * simgrid::s4u::this_actor namespace to interact with the world.
+ * This namespace contains the methods to start new activities
+ * (executions, communications, etc), and to get informations about
+ * the currently running thread (its location, etc).
+ * 
+ * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
  *
+ * 
+ * @section s4u_actor_deploy Using a deployment file
+ * 
+ * @warning This is currently not working with S4U. Sorry about that.
+ * 
+ * The best practice is to use an external deployment file as
+ * follows, because it makes it easier to test your application in
+ * differing settings. Load this file with
+ * s4u::Engine::loadDeployment() before the simulation starts. 
+ * Refer to the @ref deployment section for more information.
+ * 
+ * @code{.xml}
+ * <?xml version='1.0'?>
+ * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
+ * <platform version="4">
+ * 
+ *   <!-- Start a process called 'master' on the host called 'Tremblay' -->
+ *   <process host="Tremblay" function="master">
+ *      <!-- Here come the parameter that you want to feed to this instance of master -->
+ *      <argument value="20"/>        <!-- argv[1] -->
+ *      <argument value="50000000"/>  <!-- argv[2] -->
+ *      <argument value="1000000"/>   <!-- argv[3] -->
+ *      <argument value="5"/>         <!-- argv[4] -->
+ *   </process>
+ * 
+ *   <!-- Start a process called 'worker' on the host called 'Jupiter' -->
+ *   <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
+ * 
+ * </platform>
+ * @endcode
+ * 
+ *  @{
  */
+
+/** @brief Simulation Agent (see \ref s4u_actor)*/
 XBT_PUBLIC_CLASS Actor {
-  friend Comm;
-  Actor(smx_process_t smx_proc);
+private:
+  /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
+  template<class F, class... Args>
+  class Task {
+  public:
+    Task(F&& code, Args&&... args) :
+      code_(std::forward<F>(code)),
+      args_(std::forward<Args>(args)...)
+    {
+      done_.clear();
+    }
+    void operator()()
+    {
+      if (done_.test_and_set())
+        throw std::logic_error("Actor task already executed");
+      simgrid::xbt::apply(std::move(code_), std::move(args_));
+    }
+  private:
+    std::atomic_flag done_;
+    F code_;
+    std::tuple<Args...> args_;
+  };
+  /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
+  template<class F, class... Args>
+  static std::function<void()> wrap_task(F f, Args... args)
+  {
+    std::shared_ptr<Task<F, Args...>> task(
+      new Task<F, Args...>(std::move(f), std::move(args)...));
+    return [=] {
+      (*task)();
+    };
+  }
 public:
-  Actor(const char*name, s4u::Host *host, int argc, char **argv);
-  Actor(const char*name, s4u::Host *host, int argc, char **argv, double killTime);
-  virtual ~Actor() {}
+  Actor() : pimpl_(nullptr) {}
+  Actor(smx_process_t smx_proc) :
+    pimpl_(SIMIX_process_ref(smx_proc)) {}
+  ~Actor()
+  {
+    SIMIX_process_unref(pimpl_);
+  }
+
+  // Copy+move (with the copy-and-swap idiom):
+  Actor(Actor const& actor) : pimpl_(SIMIX_process_ref(actor.pimpl_)) {}
+  friend void swap(Actor& first, Actor& second)
+  {
+    using std::swap;
+    swap(first.pimpl_, second.pimpl_);
+  }
+  Actor& operator=(Actor actor)
+  {
+    swap(*this, actor);
+    return *this;
+  }
+  Actor(Actor&& actor) : pimpl_(nullptr)
+  {
+    swap(*this, actor);
+  }
+
+  /** Create an actor using a function
+   *
+   *  If the actor is restarted, the actor has a fresh copy of the function.
+   */
+  Actor(const char* name, s4u::Host *host, double killTime, std::function<void()> code);
+
+  Actor(const char* name, s4u::Host *host, std::function<void()> code)
+    : Actor(name, host, -1.0, std::move(code)) {};
+
+  /** Create an actor using code
+   *
+   *  Using this constructor, move-only type can be used. The consequence is
+   *  that we cannot copy the value and restart the process in its initial
+   *  state. In order to use auto-restart, an explicit `function` must be passed
+   *  instead.
+   */
+  template<class F, class... Args,
+    // This constructor is enabled only if the call code(args...) is valid:
+    typename = typename std::result_of<F(Args...)>::type
+    >
+  Actor(const char* name, s4u::Host *host, F code, Args... args) :
+    Actor(name, host, wrap_task(std::move(code), std::move(args)...))
+  {}
+
+  // Create actor from function name:
+
+  Actor(const char* name, s4u::Host *host, double killTime,
+    const char* function, std::vector<std::string> args);
 
-  /** The main method of your agent */
-  virtual int main(int argc, char **argv);
+  Actor(const char* name, s4u::Host *host, const char* function,
+      std::vector<std::string> args)
+    : Actor(name, host, -1.0, function, std::move(args)) {}
 
-  /** The Actor that is currently running */
-  static Actor *current();
   /** Retrieves the actor that have the given PID (or NULL if not existing) */
   //static Actor *byPid(int pid); not implemented
 
   /** Retrieves the name of that actor */
-  const char*getName();
+  const char* getName();
   /** Retrieves the host on which that actor is running */
   s4u::Host *getHost();
   /** Retrieves the PID of that actor */
@@ -67,8 +231,6 @@ public:
   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
   double getKillTime();
 
-  /** Ask kindly to all actors to die. Only the issuer will survive. */
-  static void killAll();
   /** Ask the actor to die.
    *
    * It will only notice your request when doing a simcall next time (a communication or similar).
@@ -76,64 +238,57 @@ public:
    */
   void kill();
 
+  static void kill(int pid);
+  static Actor forPid(int pid);
+  
+  /**
+   * Wait for the actor to finish.
+   */ 
+  void join();
+  
+  // Static methods on all actors:
+
+  /** Ask kindly to all actors to die. Only the issuer will survive. */
+  static void killAll();
+
+  bool valid() const { return pimpl_ != nullptr; }
+
+private:
+  smx_process_t pimpl_ = nullptr;
+};
+
+/** @ingroup s4u_api
+ *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
+namespace this_actor {
+
   /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
-  void sleep(double duration);
+  XBT_PUBLIC(void) sleep(double duration);
 
   /** Block the actor, computing the given amount of flops */
-  e_smx_state_t execute(double flop);
+  XBT_PUBLIC(e_smx_state_t) execute(double flop);
 
   /** Block the actor until it gets a message from the given mailbox.
    *
    * See \ref Comm for the full communication API (including non blocking communications).
    */
-  void *recv(Mailbox &chan);
+  XBT_PUBLIC(void*) recv(Mailbox &chan);
 
   /** Block the actor until it delivers a message of the given simulated size to the given mailbox
    *
    * See \ref Comm for the full communication API (including non blocking communications).
   */
-  void send(Mailbox &chan, void*payload, size_t simulatedSize);
-
-protected:
-  smx_process_t getInferior() {return p_smx_process;}
-private:
-  smx_process_t p_smx_process;
-};
-}} // namespace simgrid::s4u
-
-#endif /* SIMGRID_S4U_ACTOR_HPP */
-
-#if 0
-
-public abstract class Actor implements Runnable {
-  /** Suspends the process. See {@link #resume()} to resume it afterward */
-  public native void suspend();
-  /** Resume a process that was suspended by {@link #suspend()}. */
-  public native void resume();  
-  /** Tests if a process is suspended. */
-  public native boolean isSuspended();
+  XBT_PUBLIC(void) send(Mailbox &chan, void*payload, size_t simulatedSize);
   
   /**
-   * Returns the value of a given process property. 
+   * Return the PID of the current actor.
    */
-  public native String getProperty(String name);
+  XBT_PUBLIC(int) getPid();
 
+};
 
-  /**
-   * Migrates a process to another host.
-   *
-   * @param host      The host where to migrate the process.
-   *
-   */
-  public native void migrate(Host host);  
+/** @} */
+
+}} // namespace simgrid::s4u
 
-  public native void exit();    
-  /**
-   * This static method returns the current amount of processes running
-   *
-   * @return      The count of the running processes
-   */ 
-  public native static int getCount();
 
-}
-#endif
+#endif /* SIMGRID_S4U_ACTOR_HPP */