Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleaning the actor twice seems somewhat overplayed
[simgrid.git] / src / s4u / s4u_Actor.cpp
index 83ea571..1b45a6a 100644 (file)
@@ -1,17 +1,19 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. 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. */
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/actor.h"
 #include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "simgrid/s4u/Host.hpp"
+#include "simgrid/s4u/VirtualMachine.hpp"
 #include "src/kernel/activity/ExecImpl.hpp"
-#include "src/simix/smx_host_private.hpp"
 #include "src/simix/smx_private.hpp"
 #include "src/surf/HostImpl.hpp"
 
+#include <algorithm>
 #include <sstream>
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
@@ -19,34 +21,50 @@ XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
 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;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_creation;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_suspend;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_resume;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_sleep;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_wake_up;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_migration_start;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_migration_end;
+xbt::signal<void(ActorPtr)> s4u::Actor::on_destruction;
 
 // ***** Actor creation *****
 ActorPtr Actor::self()
 {
-  smx_context_t self_context = SIMIX_context_self();
+  smx_context_t self_context = kernel::context::Context::self();
   if (self_context == nullptr)
-    return simgrid::s4u::ActorPtr();
+    return ActorPtr();
+
+  return self_context->get_actor()->iface();
+}
+ActorPtr Actor::init(const std::string& name, s4u::Host* host)
+{
+  smx_actor_t self = SIMIX_process_self();
+  kernel::actor::ActorImpl* actor = simix::simcall([self, &name, host] { return self->init(name, host).get(); });
+  return actor->ciface();
+}
 
-  return self_context->process()->iface();
+ActorPtr Actor::start(const std::function<void()>& code)
+{
+  simgrid::simix::simcall([this, &code] { pimpl_->start(code); });
+  return this;
 }
 
-ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
+ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
 {
-  simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
+  smx_actor_t self = SIMIX_process_self();
+  kernel::actor::ActorImpl* actor =
+      simix::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); });
+
   return actor->iface();
 }
 
-ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
+ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
+                       std::vector<std::string> args)
 {
-  simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
+  simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
   return create(name, host, factory(std::move(args)));
 }
 
@@ -73,40 +91,48 @@ void Actor::join(double timeout)
 
 void Actor::set_auto_restart(bool autorestart)
 {
-  simgrid::simix::simcall([this, autorestart]() {
-    xbt_assert(autorestart && not pimpl_->auto_restart_); // FIXME: handle all cases
+  simix::simcall([this, autorestart]() {
+    xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
     pimpl_->set_auto_restart(autorestart);
 
-    simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->host_, pimpl_);
+    kernel::actor::ProcessArg* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
     XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
-    pimpl_->host_->pimpl_->actors_at_boot_.emplace_back(arg);
+    pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg);
   });
 }
 
-void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
+void Actor::on_exit(int_f_pvoid_pvoid_t fun,
+                    void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
+                                   remove the last one */
 {
-  simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+  simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
 }
 
-void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
+void Actor::on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
 {
-  simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+  on_exit([fun, data](bool exit) { fun(exit, data); });
+}
+
+void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun)
+{
+  simix::simcall(
+      [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
 }
 
 void Actor::migrate(Host* new_host)
 {
   s4u::Actor::on_migration_start(this);
 
-  simgrid::simix::simcall([this, new_host]() {
+  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
-      simgrid::kernel::activity::ExecImplPtr exec =
-          boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
+      kernel::activity::ExecImplPtr exec =
+          boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
       xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
       exec->migrate(new_host);
     }
-    SIMIX_process_change_host(this->pimpl_, new_host);
+    this->pimpl_->set_host(new_host);
   });
 
   s4u::Actor::on_migration_end(this);
@@ -114,12 +140,12 @@ void Actor::migrate(Host* new_host)
 
 s4u::Host* Actor::get_host()
 {
-  return this->pimpl_->host_;
+  return this->pimpl_->get_host();
 }
 
 void Actor::daemonize()
 {
-  simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
+  simix::simcall([this]() { pimpl_->daemonize(); });
 }
 
 bool Actor::is_daemon() const
@@ -139,12 +165,12 @@ const char* Actor::get_cname() const
 
 aid_t Actor::get_pid() const
 {
-  return this->pimpl_->pid_;
+  return this->pimpl_->get_pid();
 }
 
 aid_t Actor::get_ppid() const
 {
-  return this->pimpl_->ppid_;
+  return this->pimpl_->get_ppid();
 }
 
 void Actor::suspend()
@@ -155,32 +181,32 @@ void Actor::suspend()
 
 void Actor::resume()
 {
-  simgrid::simix::simcall([this] { pimpl_->resume(); });
+  simix::simcall([this] { pimpl_->resume(); });
   s4u::Actor::on_resume(this);
 }
 
 bool Actor::is_suspended()
 {
-  return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
+  return simix::simcall([this] { return pimpl_->is_suspended(); });
 }
 
-void Actor::set_kill_time(double time)
+void Actor::set_kill_time(double kill_time)
 {
-  simcall_process_set_kill_time(pimpl_, time);
+  simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
 }
 
 /** @brief Get the kill time of an actor(or 0 if unset). */
 double Actor::get_kill_time()
 {
-  return SIMIX_timer_get_date(pimpl_->kill_timer);
+  return pimpl_->get_kill_time();
 }
 
-void Actor::kill(aid_t pid)
+void Actor::kill(aid_t pid) // deprecated
 {
-  smx_actor_t killer  = SIMIX_process_self();
-  smx_actor_t process = SIMIX_process_from_PID(pid);
-  if (process != nullptr) {
-    simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
+  kernel::actor::ActorImpl* killer = SIMIX_process_self();
+  kernel::actor::ActorImpl* victim = SIMIX_process_from_PID(pid);
+  if (victim != nullptr) {
+    simix::simcall([killer, victim] { killer->kill(victim); });
   } else {
     std::ostringstream oss;
     oss << "kill: (" << pid << ") - No such actor" << std::endl;
@@ -190,12 +216,16 @@ void Actor::kill(aid_t pid)
 
 void Actor::kill()
 {
-  smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::simcall(
-      [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
+  kernel::actor::ActorImpl* process = SIMIX_process_self();
+  simix::simcall([this, process] {
+    if (pimpl_ == simix_global->maestro_process)
+      pimpl_->exit();
+    else
+      process->kill(pimpl_);
+  });
 }
 
-smx_actor_t Actor::get_impl()
+kernel::actor::ActorImpl* Actor::get_impl()
 {
   return pimpl_;
 }
@@ -204,7 +234,7 @@ smx_actor_t Actor::get_impl()
 
 ActorPtr Actor::by_pid(aid_t pid)
 {
-  smx_actor_t process = SIMIX_process_from_PID(pid);
+  kernel::actor::ActorImpl* process = SIMIX_process_from_PID(pid);
   if (process != nullptr)
     return process->iface();
   else
@@ -213,29 +243,29 @@ ActorPtr Actor::by_pid(aid_t pid)
 
 void Actor::kill_all()
 {
-  smx_actor_t self = SIMIX_process_self();
-  simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
+  kernel::actor::ActorImpl* self = SIMIX_process_self();
+  simix::simcall([self] { self->kill_all(); });
 }
 
 std::unordered_map<std::string, std::string>* Actor::get_properties()
 {
-  return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
+  return simix::simcall([this] { return this->pimpl_->get_properties(); });
 }
 
 /** Retrieve the property value (or nullptr if not set) */
-const char* Actor::get_property(std::string key)
+const char* Actor::get_property(const std::string& key)
 {
-  return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
+  return simix::simcall([this, &key] { return pimpl_->get_property(key); });
 }
 
-void Actor::set_property(std::string key, std::string value)
+void Actor::set_property(const std::string& key, const std::string& value)
 {
-  simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
+  simix::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
 }
 
 Actor* Actor::restart()
 {
-  return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
+  return simix::simcall([this]() { return pimpl_->restart(); });
 }
 
 // ***** this_actor *****
@@ -253,25 +283,25 @@ namespace this_actor {
  */
 bool is_maestro()
 {
-  smx_actor_t process = SIMIX_process_self();
+  kernel::actor::ActorImpl* process = SIMIX_process_self();
   return process == nullptr || process == simix_global->maestro_process;
 }
 
 void sleep_for(double duration)
 {
   if (duration > 0) {
-    smx_actor_t actor = SIMIX_process_self();
-    simgrid::s4u::Actor::on_sleep(actor->iface());
+    kernel::actor::ActorImpl* actor = SIMIX_process_self();
+    Actor::on_sleep(actor->iface());
 
     simcall_process_sleep(duration);
 
-    simgrid::s4u::Actor::on_wake_up(actor->iface());
+    Actor::on_wake_up(actor->iface());
   }
 }
 
 void yield()
 {
-  simgrid::simix::simcall([] { /* do nothing*/ });
+  simix::simcall([] { /* do nothing*/ });
 }
 
 XBT_PUBLIC void sleep_until(double timeout)
@@ -291,13 +321,14 @@ void execute(double flops, double priority)
   exec_init(flops)->set_priority(priority)->start()->wait();
 }
 
-void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
-                      std::vector<double> bytes_amounts)
+void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+                      const std::vector<double>& bytes_amounts)
 {
   parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
 }
-void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
-                      std::vector<double> bytes_amounts, double timeout)
+
+void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+                      const std::vector<double>& bytes_amounts, double timeout)
 {
   xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
   xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
@@ -305,19 +336,26 @@ void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_a
   xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
              "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
              hosts.size(), hosts.size(), flops_amounts.size());
-
-  /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
-   * but that's OK because simcall_execution_wait() is called from here too.
-   */
-  smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
-                                                      (flops_amounts.empty() ? nullptr : flops_amounts.data()),
-                                                      (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
-                                                      /* rate */ -1, timeout);
-  simcall_execution_wait(s);
+  /* Check that we are not mixing VMs and PMs in the parallel task */
+  bool is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(hosts.front()));
+  xbt_assert(std::all_of(hosts.begin(), hosts.end(),
+                         [is_a_vm](s4u::Host* elm) {
+                           bool tmp_is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(elm));
+                           return is_a_vm == tmp_is_a_vm;
+                         }),
+             "parallel_execute: mixing VMs and PMs is not supported (yet).");
+  /* checking for infinite values */
+  xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
+             "flops_amounts comprises infinite values!");
+  xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
+             "flops_amounts comprises infinite values!");
+
+  exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
 }
 
 // deprecated
-void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
+void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
+                      double timeout)
 {
   smx_activity_t s =
       simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
@@ -327,7 +365,7 @@ void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount,
 }
 
 // deprecated
-void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
+void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
 {
   smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
                                                       /* rate */ -1, /*timeout*/ -1);
@@ -338,11 +376,13 @@ void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, d
 
 ExecPtr exec_init(double flops_amount)
 {
-  ExecPtr res        = ExecPtr(new Exec());
-  res->host_         = get_host();
-  res->flops_amount_ = flops_amount;
-  res->set_remaining(flops_amount);
-  return res;
+  return ExecPtr(new ExecSeq(get_host(), flops_amount));
+}
+
+ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+                  const std::vector<double>& bytes_amounts)
+{
+  return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
 }
 
 ExecPtr exec_async(double flops)
@@ -354,12 +394,12 @@ ExecPtr exec_async(double flops)
 
 aid_t get_pid()
 {
-  return SIMIX_process_self()->pid_;
+  return SIMIX_process_self()->get_pid();
 }
 
 aid_t get_ppid()
 {
-  return SIMIX_process_self()->ppid_;
+  return SIMIX_process_self()->get_ppid();
 }
 
 std::string get_name()
@@ -374,39 +414,38 @@ const char* get_cname()
 
 Host* get_host()
 {
-  return SIMIX_process_self()->host_;
+  return SIMIX_process_self()->get_host();
 }
 
 void suspend()
 {
-  smx_actor_t actor = SIMIX_process_self();
-  simgrid::s4u::Actor::on_suspend(actor->iface());
+  kernel::actor::ActorImpl* actor = SIMIX_process_self();
+  Actor::on_suspend(actor->iface());
 
   simcall_process_suspend(actor);
 }
 
 void resume()
 {
-  smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::simcall([process] { process->resume(); });
-  simgrid::s4u::Actor::on_resume(process->iface());
+  kernel::actor::ActorImpl* self = SIMIX_process_self();
+  simix::simcall([self] { self->resume(); });
+  Actor::on_resume(self->iface());
 }
 
-bool is_suspended()
+void exit()
 {
-  smx_actor_t process = SIMIX_process_self();
-  return simgrid::simix::simcall([process] { return process->suspended_; });
+  kernel::actor::ActorImpl* self = SIMIX_process_self();
+  simgrid::simix::simcall([self] { self->exit(); });
 }
 
-void exit()
+void on_exit(const std::function<void(bool)>& fun)
 {
-  smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
+  SIMIX_process_self()->iface()->on_exit(fun);
 }
 
-void on_exit(std::function<void(int, void*)> fun, void* data)
+void on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
 {
-  SIMIX_process_self()->iface()->on_exit(fun, data);
+  SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
 }
 
 /** @brief Moves the current actor to another host
@@ -442,17 +481,13 @@ Host* getHost() /* deprecated */
 {
   return get_host();
 }
-bool isSuspended() /* deprecated */
-{
-  return is_suspended();
-}
 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 {
-  SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+  SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
 }
 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 {
-  on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+  on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
 }
 void kill() /* deprecated */
 {
@@ -470,7 +505,7 @@ void kill() /* deprecated */
  *
  * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
  */
-int sg_actor_get_PID(sg_actor_t actor)
+aid_t sg_actor_get_PID(sg_actor_t actor)
 {
   /* Do not raise an exception here: this function is called by the logs
    * and the exceptions, so it would be called back again and again */
@@ -485,7 +520,7 @@ int sg_actor_get_PID(sg_actor_t actor)
  * This function checks whether @a actor is a valid pointer and return its parent's PID.
  * Returns -1 if the actor has not been created by any other actor.
  */
-int sg_actor_get_PPID(sg_actor_t actor)
+aid_t sg_actor_get_PPID(sg_actor_t actor)
 {
   return actor->get_ppid();
 }
@@ -652,3 +687,36 @@ void sg_actor_yield()
 {
   simgrid::s4u::this_actor::yield();
 }
+
+void sg_actor_sleep_for(double duration)
+{
+  simgrid::s4u::this_actor::sleep_for(duration);
+}
+
+sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
+{
+  xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
+  std::unordered_map<std::string, std::string> props;
+  xbt_dict_cursor_t cursor = nullptr;
+  char* key;
+  char* value;
+  xbt_dict_foreach (properties, cursor, key, value)
+    props[key] = value;
+  xbt_dict_free(&properties);
+
+  /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
+  smx_actor_t actor = nullptr;
+  try {
+    actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
+  } catch (simgrid::HostFailureException const&) {
+    xbt_die("Could not attach");
+  }
+
+  simgrid::s4u::this_actor::yield();
+  return actor->ciface();
+}
+
+void sg_actor_detach()
+{
+  simgrid::kernel::actor::ActorImpl::detach();
+}