X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/92b118819a99fbc7ccb31afd7e5fe9e6ec0c4d46..bd09ae420315e4fb0d9e20749c575d17c218e5de:/include/simgrid/s4u/Actor.hpp

diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp
index e57c18555a..6d6c6d8e36 100644
--- a/include/simgrid/s4u/Actor.hpp
+++ b/include/simgrid/s4u/Actor.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2018. 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,27 +6,12 @@
 #ifndef SIMGRID_S4U_ACTOR_HPP
 #define SIMGRID_S4U_ACTOR_HPP
 
-#include <atomic>
-#include <chrono>
-#include <functional>
-#include <memory>
-#include <stdexcept>
-#include <string>
-#include <type_traits>
-#include <utility>
-#include <vector>
-
-#include <boost/intrusive_ptr.hpp>
-
+#include <simgrid/chrono.hpp>
 #include <xbt/Extendable.hpp>
-#include <xbt/base.h>
 #include <xbt/functional.hpp>
+#include <xbt/signal.hpp>
 #include <xbt/string.hpp>
 
-#include <simgrid/chrono.hpp>
-#include <simgrid/simix.h>
-#include <simgrid/s4u/forward.hpp>
-
 namespace simgrid {
 namespace s4u {
 
@@ -54,7 +39,7 @@ namespace s4u {
  * pure function or as an object. It is very simple with functions:
  *
  * @code{.cpp}
- * #include "s4u/actor.hpp"
+ * #include <simgrid/s4u/actor.hpp>
  *
  * // Declare the code of your worker
  * void worker() {
@@ -72,7 +57,7 @@ namespace s4u {
  * The syntax is slightly more complicated, but not much.
  *
  * @code{.cpp}
- * #include "s4u/actor.hpp"
+ * #include <simgrid/s4u/actor.hpp>
  *
  * // Declare the class representing your actors
  * class Worker {
@@ -113,17 +98,17 @@ namespace s4u {
  * <!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">
+ *   <!-- Start an actor called 'master' on the host called 'Tremblay' -->
+ *   <actor 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>
+ *   </actor>
  *
- *   <!-- Start a process called 'worker' on the host called 'Jupiter' -->
- *   <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
+ *   <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
+ *   <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
  *
  * </platform>
  * @endcode
@@ -132,12 +117,12 @@ namespace s4u {
  */
 
 /** @brief Simulation Agent */
-XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
-{
+class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
+  friend Exec;
   friend Mailbox;
-  friend simgrid::simix::ActorImpl;
+  friend simgrid::kernel::actor::ActorImpl;
   friend simgrid::kernel::activity::MailboxImpl;
-  simix::ActorImpl* pimpl_ = nullptr;
+  kernel::actor::ActorImpl* pimpl_ = nullptr;
 
   /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
   template<class F, class... Args>
@@ -157,171 +142,288 @@ public:
   Actor(Actor const&) = delete;
   Actor& operator=(Actor const&) = delete;
 
-  // ***** Reference count (delegated to pimpl_) *****
-  friend void intrusive_ptr_add_ref(Actor* actor)
-  {
-    xbt_assert(actor != nullptr);
-    SIMIX_process_ref(actor->pimpl_);
-  }
-  friend void intrusive_ptr_release(Actor* actor)
-  {
-    xbt_assert(actor != nullptr);
-    SIMIX_process_unref(actor->pimpl_);
-  }
+  // ***** Reference count *****
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
+  friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
 
   // ***** Actor creation *****
   /** Retrieve a reference to myself */
   static ActorPtr self();
 
+  /** Signal to others that a new actor has been created **/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_creation;
+  /** Signal to others that an actor has been suspended**/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_suspend;
+  /** Signal to others that an actor has been resumed **/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_resume;
+  /** Signal to others that an actor is sleeping **/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sleep;
+  /** Signal to others that an actor wakes up for a sleep **/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_wake_up;
+  /** Signal to others that an actor is going to migrated to another host**/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
+  /** Signal to others that an actor is has been migrated to another host **/
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
+  /** Signal indicating that the given actor is about to disappear */
+  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
+
   /** Create an actor using a function
    *
    *  If the actor is restarted, the actor has a fresh copy of the function.
    */
-  static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
+  static ActorPtr create(const char* name, s4u::Host* host, std::function<void()> code);
+
+  static ActorPtr create(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
+                         std::vector<std::string>* args)
+  {
+    return create(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
+  }
 
   /** 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
+   *  that we cannot copy the value and restart the actor 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
-    >
-  static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
+  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>
+  static ActorPtr create(const char* name, s4u::Host* host, F code, Args... args)
   {
-    return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
+    return create(name, host, wrap_task(std::move(code), std::move(args)...));
   }
 
   // Create actor from function name:
-
-  static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
+  static ActorPtr create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
 
   // ***** Methods *****
+  /** This actor will be automatically terminated when the last non-daemon actor finishes **/
+  void daemonize();
+
+  /** Returns whether or not this actor has been daemonized or not **/
+  bool is_daemon() const;
 
-  /** Retrieves the name of that actor as a C string */
-  const char* cname();
   /** Retrieves the name of that actor as a C++ string */
-  simgrid::xbt::string name();
+  const simgrid::xbt::string& get_name() const;
+  /** Retrieves the name of that actor as a C string */
+  const char* get_cname() const;
   /** Retrieves the host on which that actor is running */
-  s4u::Host* host();
-  /** Retrieves the PID of that actor */
-  int pid();
-  /** Retrieves the PPID of that actor */
-  int ppid();
+  s4u::Host* get_host();
+  /** Retrieves the PID of that actor
+   *
+   * aid_t is an alias for long */
+  aid_t get_pid() const;
+  /** Retrieves the PPID of that actor
+   *
+   * aid_t is an alias for long */
+  aid_t get_ppid() const;
 
   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
   void suspend();
 
-  /** Resume a suspended process by resuming the task on which it was waiting for the completion. */
+  /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
   void resume();
 
+  void yield();
+
+  /** Returns true if the actor is suspended. */
+  int is_suspended();
+
   /** If set to true, the actor will automatically restart when its host reboots */
-  void setAutoRestart(bool autorestart);
+  void set_auto_restart(bool autorestart);
+
+  /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
+   * executed when your actor is killed. You should use them to free the data used by your actor.
+   */
+  void on_exit(int_f_pvoid_pvoid_t fun, void* data);
+
   /** Sets the time at which that actor should be killed */
-  void setKillTime(double time);
+  void set_kill_time(double time);
   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
-  double killTime();
+  double get_kill_time();
 
   void migrate(Host * new_host);
+
   /** Ask the actor to die.
    *
-   * It will only notice your request when doing a simcall next time (a communication or similar).
-   * SimGrid sometimes have issues when you kill actors that are currently communicating and such.
+   * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
+   * Being killed is not something that actors can defer or avoid.
+   *
+   * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
    * Still. Please report any bug that you may encounter with a minimal working example.
    */
   void kill();
 
-  static void kill(int pid);
+  static void kill(aid_t pid);
 
   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
-  static ActorPtr byPid(int pid);
+  static ActorPtr by_pid(aid_t pid);
 
   /** @brief Wait for the actor to finish.
    *
    * This blocks the calling actor until the actor on which we call join() is terminated
    */
   void join();
-  
-  // Static methods on all actors:
+  void join(double timeout);
+  Actor* restart();
 
   /** Ask kindly to all actors to die. Only the issuer will survive. */
-  static void killAll();
+  static void kill_all();
 
   /** Returns the internal implementation of this actor */
-  simix::ActorImpl* getImpl();
-};
-
-/** @ingroup s4u_api
- *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
-namespace this_actor {
+  kernel::actor::ActorImpl* get_impl();
 
-  /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
-  XBT_PUBLIC(void) sleep_for(double duration);
-  XBT_PUBLIC(void) sleep_until(double timeout);
+  /** Retrieve the property value (or nullptr if not set) */
+  std::map<std::string, std::string>* get_properties(); // FIXME: do not export the map, but only the keys or something
+  const char* get_property(const char* key);
+  void set_property(const char* key, const char* value);
 
-  template<class Rep, class Period>
-  inline void sleep_for(std::chrono::duration<Rep, Period> duration)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
+      createActor(const char* name, s4u::Host* host, std::function<void()> code)
   {
-    auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
-    this_actor::sleep_for(seconds.count());
+    return create(name, host, code);
   }
-  template<class Duration>
-  inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
+      createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
+                  std::vector<std::string>* args)
   {
-    auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
-    this_actor::sleep_until(timeout_native.time_since_epoch().count());
+    return create(name, host, code, args);
   }
-
-  XBT_ATTRIB_DEPRECATED("Use sleep_for()")
-  inline void sleep(double duration)
+  template <class F, class... Args, typename = typename std::result_of<F(Args...)>::type>
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
+      createActor(const char* name, s4u::Host* host, F code, Args... args)
+  {
+    return create(name, host, code, std::move(args)...);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
+      createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
   {
-    return sleep_for(duration);
+    return create(name, host, function, args);
   }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const;
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const
+  {
+    return get_name();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a)
+  {
+    set_auto_restart(a);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
+  {
+    on_exit(fun, data);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll(int resetPid)
+  {
+    kill_all();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key)
+  {
+    return get_property(key);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map<std::string, std::string>* getProperties()
+  {
+    return get_properties();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value)
+  {
+    set_property(key, value);
+  }
+};
+
+/** @ingroup s4u_api
+ *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
+namespace this_actor {
 
-  /** Block the actor, computing the given amount of flops */
-  XBT_PUBLIC(e_smx_state_t) execute(double flop);
+XBT_PUBLIC bool is_maestro();
 
-  /** Block the actor until it gets a message from the given mailbox.
-   *
-   * See \ref Comm for the full communication API (including non blocking communications).
-   */
-  XBT_PUBLIC(void*) recv(MailboxPtr chan);
+/** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
+XBT_PUBLIC void sleep_for(double duration);
+XBT_PUBLIC void sleep_until(double timeout);
 
-  /** 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).
-  */
-  XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize);
+template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
+{
+  auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
+  this_actor::sleep_for(seconds.count());
+}
+
+template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
+{
+  auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
+  this_actor::sleep_until(timeout_native.time_since_epoch().count());
+}
 
-  /** @brief Returns the PID of the current actor. */
-  XBT_PUBLIC(int) pid();
+/** Block the actor, computing the given amount of flops */
+XBT_PUBLIC void execute(double flop);
 
-  /** @brief Returns the PPID of the current actor. */
-  XBT_PUBLIC(int) ppid();
+/** Block the actor, computing the given amount of flops at the given priority.
+ *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
+XBT_PUBLIC void execute(double flop, double priority);
 
-  /** @brief Returns the name of the current actor. */
-  XBT_PUBLIC(std::string) name();
+XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
+XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
+                                 double timeout);
 
-  /** @brief Returns the name of the host on which the process is running. */
-  XBT_PUBLIC(Host*) host();
+XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
+XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
 
-  /** @brief Suspend the actor. */
-  XBT_PUBLIC(void) suspend();
+/** @brief Returns the actor ID of the current actor). */
+XBT_PUBLIC aid_t get_pid();
 
-  /** @brief Resume the actor. */
-  XBT_PUBLIC(void) resume();
+/** @brief Returns the ancestor's actor ID of the current actor. */
+XBT_PUBLIC aid_t get_ppid();
 
-  /** @brief kill the actor. */
-  XBT_PUBLIC(void) kill();
+/** @brief Returns the name of the current actor. */
+XBT_PUBLIC std::string get_name();
+/** @brief Returns the name of the current actor as a C string. */
+XBT_PUBLIC const char* get_cname();
 
-  /** @brief Migrate the actor to a new host. */
-  XBT_PUBLIC(void) migrate(Host* new_host);
-};
+/** @brief Returns the name of the host on which the actor is running. */
+XBT_PUBLIC Host* get_host();
+
+/** @brief Suspend the actor. */
+XBT_PUBLIC void suspend();
+
+/** @brief yield the actor. */
+XBT_PUBLIC void yield();
+
+/** @brief Resume the actor. */
+XBT_PUBLIC void resume();
+
+XBT_PUBLIC bool is_suspended();
+
+/** @brief kill the actor. */
+XBT_PUBLIC void kill();
+
+/** @brief Add a function to the list of "on_exit" functions. */
+XBT_PUBLIC void on_exit(int_f_pvoid_pvoid_t fun, void* data);
+
+/** @brief Migrate the actor to a new host. */
+XBT_PUBLIC void migrate(Host* new_host);
+
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended();
+XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC
+    void onExit(int_f_pvoid_pvoid_t fun, void* data);
+}
 
-/** @} */
+/** @} */
 
 }} // namespace simgrid::s4u