Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Define Actor::on_exit() taking a std::function.
[simgrid.git] / src / s4u / s4u_Actor.cpp
index 2228a91..bd5b149 100644 (file)
@@ -3,11 +3,12 @@
 /* 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. */
 
+#include "simgrid/actor.h"
 #include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "simgrid/s4u/Host.hpp"
-#include "src/instr/instr_private.hpp"
 #include "src/simix/smx_private.hpp"
+#include <sstream>
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
 
@@ -15,6 +16,12 @@ namespace simgrid {
 namespace s4u {
 
 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
 
 // ***** Actor creation *****
@@ -64,12 +71,17 @@ void Actor::join(double timeout)
 
 void Actor::set_auto_restart(bool autorestart)
 {
-  simgrid::simix::kernelImmediate([this, autorestart]() { pimpl_->auto_restart = autorestart; });
+  simgrid::simix::simcall([this, autorestart]() { pimpl_->auto_restart = autorestart; });
 }
 
 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data)
 {
-  simcall_process_on_exit(pimpl_, fun, data);
+  simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+}
+
+void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
+{
+  simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
 }
 
 /** @brief Moves the actor to another host
@@ -83,25 +95,9 @@ void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data)
  */
 void Actor::migrate(Host* new_host)
 {
-  std::string key;
-  simgrid::instr::LinkType* link = nullptr;
-  bool tracing                   = TRACE_actor_is_enabled();
-  if (tracing) {
-    static long long int counter = 0;
-
-    key = std::to_string(counter);
-    counter++;
-
-    // start link
-    container_t actor_container = simgrid::instr::Container::byName(instr_pid(this));
-    link                        = simgrid::instr::Container::getRoot()->getLink("ACTOR_LINK");
-    link->startEvent(actor_container, "M", key);
+  s4u::Actor::on_migration_start(this);
 
-    // destroy existing container of this process
-    actor_container->removeFromParent();
-  }
-
-  simgrid::simix::kernelImmediate([this, new_host]() {
+  simgrid::simix::simcall([this, new_host]() {
     if (pimpl_->waiting_synchro != nullptr) {
       // The actor is blocked on an activity. If it's an exec, migrate it too.
       // FIXME: implement the migration of other kind of activities
@@ -113,12 +109,7 @@ void Actor::migrate(Host* new_host)
     SIMIX_process_change_host(this->pimpl_, new_host);
   });
 
-  if (tracing) {
-    // create new container on the new_host location
-    simgrid::instr::Container::byName(new_host->get_name())->createChild(instr_pid(this), "ACTOR");
-    // end link
-    link->endEvent(simgrid::instr::Container::byName(instr_pid(this)), "M", key);
-  }
+  s4u::Actor::on_migration_end(this);
 }
 
 s4u::Host* Actor::get_host()
@@ -128,7 +119,7 @@ s4u::Host* Actor::get_host()
 
 void Actor::daemonize()
 {
-  simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
+  simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
 }
 
 bool Actor::is_daemon() const
@@ -158,22 +149,19 @@ aid_t Actor::get_ppid() const
 
 void Actor::suspend()
 {
-  if (TRACE_actor_is_enabled())
-    simgrid::instr::Container::byName(instr_pid(this))->getState("ACTOR_STATE")->pushEvent("suspend");
-
+  s4u::Actor::on_suspend(this);
   simcall_process_suspend(pimpl_);
 }
 
 void Actor::resume()
 {
-  simgrid::simix::kernelImmediate([this] { pimpl_->resume(); });
-  if (TRACE_actor_is_enabled())
-    simgrid::instr::Container::byName(instr_pid(this))->getState("ACTOR_STATE")->popEvent();
+  simgrid::simix::simcall([this] { pimpl_->resume(); });
+  s4u::Actor::on_resume(this);
 }
 
 int Actor::is_suspended()
 {
-  return simgrid::simix::kernelImmediate([this] { return pimpl_->suspended; });
+  return simgrid::simix::simcall([this] { return pimpl_->suspended; });
 }
 
 void Actor::set_kill_time(double time)
@@ -192,7 +180,7 @@ void Actor::kill(aid_t pid)
   smx_actor_t killer  = SIMIX_process_self();
   smx_actor_t process = SIMIX_process_from_PID(pid);
   if (process != nullptr) {
-    simgrid::simix::kernelImmediate([killer, process] { SIMIX_process_kill(process, killer); });
+    simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
   } else {
     std::ostringstream oss;
     oss << "kill: (" << pid << ") - No such actor" << std::endl;
@@ -203,7 +191,7 @@ void Actor::kill(aid_t pid)
 void Actor::kill()
 {
   smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::kernelImmediate(
+  simgrid::simix::simcall(
       [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
 }
 
@@ -226,28 +214,28 @@ ActorPtr Actor::by_pid(aid_t pid)
 void Actor::kill_all()
 {
   smx_actor_t self = SIMIX_process_self();
-  simgrid::simix::kernelImmediate([&self] { SIMIX_process_killall(self); });
+  simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
 }
 
 std::map<std::string, std::string>* Actor::get_properties()
 {
-  return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
+  return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
 }
 
 /** Retrieve the property value (or nullptr if not set) */
 const char* Actor::get_property(const char* key)
 {
-  return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
+  return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
 }
 
 void Actor::set_property(const char* key, const char* value)
 {
-  simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
+  simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
 }
 
 Actor* Actor::restart()
 {
-  return simgrid::simix::kernelImmediate([this]() { return pimpl_->restart(); });
+  return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
 }
 
 // ***** this_actor *****
@@ -271,45 +259,48 @@ bool is_maestro()
 
 void sleep_for(double duration)
 {
-  if (duration > 0)
+  if (duration > 0) {
+    smx_actor_t actor = SIMIX_process_self();
+    simgrid::s4u::Actor::on_sleep(actor->iface());
+
     simcall_process_sleep(duration);
+
+    simgrid::s4u::Actor::on_wake_up(actor->iface());
+  }
 }
 
 void yield()
 {
-  simgrid::simix::kernelImmediate([] { /* do nothing*/ });
+  simgrid::simix::simcall([] { /* do nothing*/ });
 }
 
 XBT_PUBLIC void sleep_until(double timeout)
 {
   double now = SIMIX_get_clock();
   if (timeout > now)
-    simcall_process_sleep(timeout - now);
+    sleep_for(timeout - now);
 }
 
 void execute(double flops)
 {
-  smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, get_host());
-  simcall_execution_wait(s);
+  get_host()->execute(flops);
 }
 
 void execute(double flops, double priority)
 {
-  smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, get_host());
-  simcall_execution_wait(s);
+  get_host()->execute(flops, priority);
 }
 
-void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout)
+void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
 {
   smx_activity_t s =
-      simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, timeout);
+      simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
   simcall_execution_wait(s);
 }
 
 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
 {
-  smx_activity_t s = simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, -1);
-  simcall_execution_wait(s);
+  parallel_execute(host_nb, host_list, flops_amount, bytes_amount, /* timeout */ -1);
 }
 
 ExecPtr exec_init(double flops_amount)
@@ -355,37 +346,39 @@ Host* get_host()
 
 void suspend()
 {
-  if (TRACE_actor_is_enabled())
-    instr::Container::byName(get_name() + "-" + std::to_string(get_pid()))
-        ->getState("ACTOR_STATE")
-        ->pushEvent("suspend");
-  simcall_process_suspend(SIMIX_process_self());
+  smx_actor_t actor = SIMIX_process_self();
+  simgrid::s4u::Actor::on_suspend(actor->iface());
+
+  simcall_process_suspend(actor);
 }
 
 void resume()
 {
   smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::kernelImmediate([process] { process->resume(); });
-
-  if (TRACE_actor_is_enabled())
-    instr::Container::byName(get_name() + "-" + std::to_string(get_pid()))->getState("ACTOR_STATE")->popEvent();
+  simgrid::simix::simcall([process] { process->resume(); });
+  simgrid::s4u::Actor::on_resume(process->iface());
 }
 
 bool is_suspended()
 {
   smx_actor_t process = SIMIX_process_self();
-  return simgrid::simix::kernelImmediate([process] { return process->suspended; });
+  return simgrid::simix::simcall([process] { return process->suspended; });
 }
 
 void kill()
 {
   smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
+  simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
 }
 
 void on_exit(int_f_pvoid_pvoid_t fun, void* data)
 {
-  simcall_process_on_exit(SIMIX_process_self(), fun, data);
+  SIMIX_process_self()->iface()->on_exit(fun, data);
+}
+
+void on_exit(std::function<void(int, void*)> fun, void* data)
+{
+  SIMIX_process_self()->iface()->on_exit(fun, data);
 }
 
 /** @brief Moves the current actor to another host
@@ -461,6 +454,19 @@ int sg_actor_get_PPID(sg_actor_t actor)
   return actor->get_ppid();
 }
 
+/** \ingroup m_actor_management
+ *
+ * \brief Return a #sg_actor_t given its PID.
+ *
+ * This function search in the list of all the created sg_actor_t for a sg_actor_t  whose PID is equal to \a PID.
+ * If none is found, \c nullptr is returned.
+   Note that the PID are unique in the whole simulation, not only on a given host.
+ */
+sg_actor_t sg_actor_by_PID(aid_t pid)
+{
+  return simgrid::s4u::Actor::by_pid(pid).get();
+}
+
 /** \ingroup m_actor_management
  * \brief Return the name of an actor.
  */
@@ -545,6 +551,16 @@ sg_actor_t sg_actor_restart(sg_actor_t actor)
   return actor->restart();
 }
 
+/**
+ * \ingroup m_actor_management
+ * \brief Sets the "auto-restart" flag of the actor.
+ * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
+ */
+void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
+{
+  actor->set_auto_restart(auto_restart);
+}
+
 /** @ingroup m_actor_management
  * @brief This actor will be terminated automatically when the last non-daemon actor finishes
  */
@@ -579,6 +595,11 @@ void sg_actor_kill(sg_actor_t actor)
   actor->kill();
 }
 
+void sg_actor_kill_all()
+{
+  simgrid::s4u::Actor::kill_all();
+}
+
 /** \ingroup m_actor_management
  * \brief Set the kill time of an actor.
  *
@@ -589,3 +610,9 @@ void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 {
   actor->set_kill_time(kill_time);
 }
+
+/** Yield the current actor; let the other actors execute first */
+void sg_actor_yield()
+{
+  simgrid::s4u::this_actor::yield();
+}