Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make SIMIX_context_self() useless and use Context::self() instead
[simgrid.git] / src / s4u / s4u_Actor.cpp
index 105cd93..f693e25 100644 (file)
@@ -7,7 +7,11 @@
 #include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "simgrid/s4u/Host.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 <sstream>
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
@@ -27,25 +31,23 @@ simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
 // ***** Actor creation *****
 ActorPtr Actor::self()
 {
-  smx_context_t self_context = SIMIX_context_self();
+  smx_context_t self_context = simgrid::kernel::context::Context::self();
   if (self_context == nullptr)
     return simgrid::s4u::ActorPtr();
 
   return self_context->process()->iface();
 }
 
-ActorPtr Actor::create(const char* name, s4u::Host* host, std::function<void()> code)
+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);
   return actor->iface();
 }
 
-ActorPtr Actor::create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
+ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
 {
   simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
-  simgrid::simix::ActorCode code            = factory(std::move(args));
-  simgrid::kernel::actor::ActorImpl* actor  = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
-  return actor->iface();
+  return create(name, host, factory(std::move(args)));
 }
 
 void intrusive_ptr_add_ref(Actor* actor)
@@ -71,7 +73,14 @@ void Actor::join(double timeout)
 
 void Actor::set_auto_restart(bool autorestart)
 {
-  simgrid::simix::simcall([this, autorestart]() { pimpl_->auto_restart = autorestart; });
+  simgrid::simix::simcall([this, autorestart]() {
+    xbt_assert(autorestart && not pimpl_->auto_restart_); // FIXME: handle all cases
+    pimpl_->set_auto_restart(autorestart);
+
+    simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->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);
+  });
 }
 
 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
@@ -84,15 +93,6 @@ 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
- *
- * If the actor is currently blocked on an execution activity, the activity is also
- * migrated to the new host. If it's blocked on another kind of activity, an error is
- * raised as the mandated code is not written yet. Please report that bug if you need it.
- *
- * Asynchronous activities started by the actor are not migrated automatically, so you have
- * to take care of this yourself (only you knows which ones should be migrated).
- */
 void Actor::migrate(Host* new_host)
 {
   s4u::Actor::on_migration_start(this);
@@ -114,7 +114,7 @@ void Actor::migrate(Host* new_host)
 
 s4u::Host* Actor::get_host()
 {
-  return this->pimpl_->host;
+  return this->pimpl_->host_;
 }
 
 void Actor::daemonize()
@@ -124,7 +124,7 @@ void Actor::daemonize()
 
 bool Actor::is_daemon() const
 {
-  return this->pimpl_->isDaemon();
+  return this->pimpl_->is_daemon();
 }
 
 const simgrid::xbt::string& Actor::get_name() const
@@ -139,12 +139,12 @@ const char* Actor::get_cname() const
 
 aid_t Actor::get_pid() const
 {
-  return this->pimpl_->pid;
+  return this->pimpl_->pid_;
 }
 
 aid_t Actor::get_ppid() const
 {
-  return this->pimpl_->ppid;
+  return this->pimpl_->ppid_;
 }
 
 void Actor::suspend()
@@ -159,9 +159,9 @@ void Actor::resume()
   s4u::Actor::on_resume(this);
 }
 
-int Actor::is_suspended()
+bool Actor::is_suspended()
 {
-  return simgrid::simix::simcall([this] { return pimpl_->suspended; });
+  return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
 }
 
 void Actor::set_kill_time(double time)
@@ -169,7 +169,7 @@ void Actor::set_kill_time(double time)
   simcall_process_set_kill_time(pimpl_, time);
 }
 
-/** \brief Get the kill time of an actor(or 0 if unset). */
+/** @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);
@@ -223,12 +223,12 @@ std::unordered_map<std::string, std::string>* Actor::get_properties()
 }
 
 /** Retrieve the property value (or nullptr if not set) */
-const char* Actor::get_property(const char* key)
+const char* Actor::get_property(std::string key)
 {
   return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
 }
 
-void Actor::set_property(const char* key, const char* value)
+void Actor::set_property(std::string key, std::string value)
 {
   simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
 }
@@ -283,24 +283,57 @@ XBT_PUBLIC void sleep_until(double timeout)
 
 void execute(double flops)
 {
-  get_host()->execute(flops);
+  execute(flops, 1.0 /* priority */);
 }
 
 void execute(double flops, double priority)
 {
-  get_host()->execute(flops, 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)
+{
+  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)
+{
+  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(),
+             "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
+  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);
+}
+
+// deprecated
 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, /* rate */ -1, timeout);
+      simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
   simcall_execution_wait(s);
+  delete[] flops_amount;
+  delete[] bytes_amount;
 }
 
+// deprecated
 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
 {
-  parallel_execute(host_nb, host_list, flops_amount, bytes_amount, /* timeout */ -1);
+  smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
+                                                      /* rate */ -1, /*timeout*/ -1);
+  simcall_execution_wait(s);
+  delete[] flops_amount;
+  delete[] bytes_amount;
 }
 
 ExecPtr exec_init(double flops_amount)
@@ -321,12 +354,12 @@ ExecPtr exec_async(double flops)
 
 aid_t get_pid()
 {
-  return SIMIX_process_self()->pid;
+  return SIMIX_process_self()->pid_;
 }
 
 aid_t get_ppid()
 {
-  return SIMIX_process_self()->ppid;
+  return SIMIX_process_self()->ppid_;
 }
 
 std::string get_name()
@@ -341,7 +374,7 @@ const char* get_cname()
 
 Host* get_host()
 {
-  return SIMIX_process_self()->host;
+  return SIMIX_process_self()->host_;
 }
 
 void suspend()
@@ -362,10 +395,10 @@ void resume()
 bool is_suspended()
 {
   smx_actor_t process = SIMIX_process_self();
-  return simgrid::simix::simcall([process] { return process->suspended; });
+  return simgrid::simix::simcall([process] { return process->suspended_; });
 }
 
-void kill()
+void exit()
 {
   smx_actor_t process = SIMIX_process_self();
   simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
@@ -421,6 +454,10 @@ 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);
 }
+void kill() /* deprecated */
+{
+  exit();
+}
 
 } // namespace this_actor
 } // namespace s4u
@@ -428,10 +465,10 @@ void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 
 /* **************************** Public C interface *************************** */
 
-/** \ingroup m_actor_management
- * \brief Returns the process ID of \a actor.
+/** @ingroup m_actor_management
+ * @brief Returns the process ID of @a actor.
  *
- * This function checks whether \a actor is a valid pointer and return its PID (or 0 in case of problem).
+ * 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)
 {
@@ -442,10 +479,10 @@ int sg_actor_get_PID(sg_actor_t actor)
   return actor->get_pid();
 }
 
-/** \ingroup m_actor_management
- * \brief Returns the process ID of the parent of \a actor.
+/** @ingroup m_actor_management
+ * @brief Returns the process ID of the parent of @a actor.
  *
- * This function checks whether \a actor is a valid pointer and return its parent's PID.
+ * 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)
@@ -453,12 +490,12 @@ int sg_actor_get_PPID(sg_actor_t actor)
   return actor->get_ppid();
 }
 
-/** \ingroup m_actor_management
+/** @ingroup m_actor_management
  *
- * \brief Return a #sg_actor_t given its PID.
+ * @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.
+ * 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)
@@ -466,8 +503,8 @@ 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.
+/** @ingroup m_actor_management
+ * @brief Return the name of an actor.
  */
 const char* sg_actor_get_name(sg_actor_t actor)
 {
@@ -479,20 +516,20 @@ sg_host_t sg_actor_get_host(sg_actor_t actor)
   return actor->get_host();
 }
 
-/** \ingroup m_actor_management
- * \brief Returns the value of a given actor property
+/** @ingroup m_actor_management
+ * @brief Returns the value of a given actor property
  *
- * \param actor an actor
- * \param name a property name
- * \return value of a property (or nullptr if the property is not set)
+ * @param actor an actor
+ * @param name a property name
+ * @return value of a property (or nullptr if the property is not set)
  */
 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
 {
   return actor->get_property(name);
 }
 
-/** \ingroup m_actor_management
- * \brief Return the list of properties
+/** @ingroup m_actor_management
+ * @brief Return the list of properties
  *
  * This function returns all the parameters associated with an actor
  */
@@ -509,8 +546,8 @@ xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
   return as_dict;
 }
 
-/** \ingroup m_actor_management
- * \brief Suspend the actor.
+/** @ingroup m_actor_management
+ * @brief Suspend the actor.
  *
  * This function suspends the actor by suspending the task on which it was waiting for the completion.
  */
@@ -520,8 +557,8 @@ void sg_actor_suspend(sg_actor_t actor)
   actor->suspend();
 }
 
-/** \ingroup m_actor_management
- * \brief Resume a suspended actor.
+/** @ingroup m_actor_management
+ * @brief Resume a suspended actor.
  *
  * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
  */
@@ -531,8 +568,8 @@ void sg_actor_resume(sg_actor_t actor)
   actor->resume();
 }
 
-/** \ingroup m_actor_management
- * \brief Returns true if the actor is suspended .
+/** @ingroup m_actor_management
+ * @brief Returns true if the actor is suspended .
  *
  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
  */
@@ -542,8 +579,8 @@ int sg_actor_is_suspended(sg_actor_t actor)
 }
 
 /**
- * \ingroup m_actor_management
- * \brief Restarts an actor from the beginning.
+ * @ingroup m_actor_management
+ * @brief Restarts an actor from the beginning.
  */
 sg_actor_t sg_actor_restart(sg_actor_t actor)
 {
@@ -551,8 +588,8 @@ sg_actor_t sg_actor_restart(sg_actor_t actor)
 }
 
 /**
- * \ingroup m_actor_management
- * \brief Sets the "auto-restart" flag of the actor.
+ * @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)
@@ -568,21 +605,21 @@ void sg_actor_daemonize(sg_actor_t actor)
   actor->daemonize();
 }
 
-/** \ingroup m_actor_management
- * \brief Migrates an actor to another location.
+/** @ingroup m_actor_management
+ * @brief Migrates an actor to another location.
  *
- * This function changes the value of the #sg_host_t on  which \a actor is running.
+ * This function changes the value of the #sg_host_t on  which @a actor is running.
  */
 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
 {
   process->migrate(host);
 }
 
-/** \ingroup m_actor_management
- * \brief Wait for the completion of a #sg_actor_t.
+/** @ingroup m_actor_management
+ * @brief Wait for the completion of a #sg_actor_t.
  *
- * \param actor the actor to wait for
- * \param timeout wait until the actor is over, or the timeout expires
+ * @param actor the actor to wait for
+ * @param timeout wait until the actor is over, or the timeout expires
  */
 void sg_actor_join(sg_actor_t actor, double timeout)
 {
@@ -599,11 +636,11 @@ void sg_actor_kill_all()
   simgrid::s4u::Actor::kill_all();
 }
 
-/** \ingroup m_actor_management
- * \brief Set the kill time of an actor.
+/** @ingroup m_actor_management
+ * @brief Set the kill time of an actor.
  *
- * \param actor an actor
- * \param kill_time the time when the actor is killed.
+ * @param actor an actor
+ * @param kill_time the time when the actor is killed.
  */
 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 {