Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Sanitize the prototype of Actor::on_exit() callbacks
[simgrid.git] / src / s4u / s4u_Actor.cpp
index 7e1d404..005dc0b 100644 (file)
@@ -3,6 +3,7 @@
 /* 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"
@@ -40,14 +41,15 @@ ActorPtr Actor::self()
 
 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
 {
-  simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
+  simgrid::kernel::actor::ActorImpl* actor =
+      simcall_process_create(std::move(name), std::move(code), nullptr, host, nullptr);
   return actor->iface();
 }
 
-ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
+ActorPtr Actor::create(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);
-  return create(name, host, factory(std::move(args)));
+  return create(std::move(name), host, factory(std::move(args)));
 }
 
 void intrusive_ptr_add_ref(Actor* actor)
@@ -74,23 +76,26 @@ 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
+    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_);
+    simgrid::kernel::actor::ProcessArg* arg = new simgrid::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); });
 }
 
-void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
+void Actor::on_exit(std::function<void(bool /*failed*/)> fun)
 {
-  simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+  simgrid::simix::simcall(
+      [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* data) { fun(a != 0); }, nullptr); });
 }
 
 void Actor::migrate(Host* new_host)
@@ -106,7 +111,7 @@ void Actor::migrate(Host* new_host)
       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,7 +119,7 @@ void Actor::migrate(Host* new_host)
 
 s4u::Host* Actor::get_host()
 {
-  return this->pimpl_->host_;
+  return this->pimpl_->get_host();
 }
 
 void Actor::daemonize()
@@ -139,12 +144,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()
@@ -161,7 +166,7 @@ void Actor::resume()
 
 bool Actor::is_suspended()
 {
-  return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
+  return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
 }
 
 void Actor::set_kill_time(double kill_time)
@@ -172,15 +177,15 @@ void Actor::set_kill_time(double 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) // 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); });
+  smx_actor_t victim  = SIMIX_process_from_PID(pid);
+  if (victim != nullptr) {
+    simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
   } else {
     std::ostringstream oss;
     oss << "kill: (" << pid << ") - No such actor" << std::endl;
@@ -191,8 +196,12 @@ void Actor::kill(aid_t pid) // deprecated
 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); });
+  simgrid::simix::simcall([this, process] {
+    if (pimpl_ == simix_global->maestro_process)
+      pimpl_->exit();
+    else
+      process->kill(pimpl_);
+  });
 }
 
 smx_actor_t Actor::get_impl()
@@ -214,7 +223,7 @@ 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); });
+  simgrid::simix::simcall([self] { self->kill_all(); });
 }
 
 std::unordered_map<std::string, std::string>* Actor::get_properties()
@@ -223,14 +232,14 @@ std::unordered_map<std::string, std::string>* Actor::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); });
 }
 
-void Actor::set_property(std::string key, std::string value)
+void Actor::set_property(const std::string& key, std::string value)
 {
-  simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
+  simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, std::move(value)); });
 }
 
 Actor* Actor::restart()
@@ -291,13 +300,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(),
@@ -317,7 +327,8 @@ void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_a
 }
 
 // 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 +338,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);
@@ -350,12 +361,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()
@@ -370,7 +381,7 @@ const char* get_cname()
 
 Host* get_host()
 {
-  return SIMIX_process_self()->host_;
+  return SIMIX_process_self()->get_host();
 }
 
 void suspend()
@@ -390,13 +401,18 @@ void resume()
 
 void exit()
 {
-  smx_actor_t process = SIMIX_process_self();
-  simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
+  smx_actor_t actor = SIMIX_process_self();
+  simgrid::simix::simcall([actor] { actor->exit(); });
+}
+
+void on_exit(std::function<void(bool)> fun)
+{
+  SIMIX_process_self()->iface()->on_exit(fun);
 }
 
-void on_exit(std::function<void(int, void*)> fun, void* data)
+void on_exit(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
@@ -434,11 +450,11 @@ Host* getHost() /* deprecated */
 }
 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 */
 {
@@ -638,3 +654,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();
+}