Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Define overridable Activity::complete() to be called on activity completion.
[simgrid.git] / src / s4u / s4u_Exec.cpp
index 85874d2..324e2ab 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2021. 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. */
@@ -8,18 +8,50 @@
 #include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "src/kernel/activity/ExecImpl.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
+#include "src/kernel/actor/SimcallObserver.hpp"
 #include "xbt/log.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
 
 namespace simgrid {
 namespace s4u {
-xbt::signal<void(Actor const&, Exec const&)> Exec::on_start;
-xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion;
+xbt::signal<void(Exec const&)> Exec::on_start;
+xbt::signal<void(Exec const&)> Exec::on_completion;
 
-Exec::Exec()
+Exec::Exec(kernel::activity::ExecImplPtr pimpl)
 {
-  pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
+  pimpl_ = pimpl;
+}
+
+void Exec::complete(Activity::State state)
+{
+  Activity::complete(state);
+  on_completion(*this);
+}
+
+ExecPtr Exec::init()
+{
+  auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
+  return ExecPtr(pimpl->get_iface());
+}
+
+Exec* Exec::start()
+{
+  kernel::actor::simcall([this] {
+    (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
+        .set_name(get_name())
+        .set_tracing_category(get_tracing_category())
+        .start();
+  });
+
+  if (suspended_)
+    pimpl_->suspend();
+
+  state_      = State::STARTED;
+  start_time_ = pimpl_->surf_action_->get_start_time();
+  on_start(*this);
+  return this;
 }
 
 Exec* Exec::wait()
@@ -32,30 +64,34 @@ Exec* Exec::wait_for(double timeout)
   if (state_ == State::INITED)
     vetoable_start();
 
-  kernel::actor::ActorImpl* issuer = Actor::self()->get_impl();
-  kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
-  state_ = State::FINISHED;
-  on_completion(*Actor::self(), *this);
-  this->release_dependencies();
+  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+  kernel::actor::simcall_blocking([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
+  complete(State::FINISHED);
   return this;
 }
 
 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
 {
-  std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
-  std::transform(begin(*execs), end(*execs), rexecs.get(),
+  std::vector<kernel::activity::ExecImpl*> rexecs(execs->size());
+  std::transform(begin(*execs), end(*execs), begin(rexecs),
                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
 
-  int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
+  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+  kernel::actor::ExecutionWaitanySimcall observer{issuer, rexecs, timeout};
+  int changed_pos = kernel::actor::simcall_blocking(
+      [&observer] {
+        kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(), observer.get_timeout());
+      },
+      &observer);
   if (changed_pos != -1)
-    execs->at(changed_pos)->release_dependencies();
+    execs->at(changed_pos)->complete(State::FINISHED);
   return changed_pos;
 }
 
 Exec* Exec::cancel()
 {
   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
-  state_ = State::CANCELED;
+  complete(State::CANCELED);
   return this;
 }
 
@@ -65,37 +101,67 @@ Exec* Exec::cancel()
  */
 ExecPtr Exec::set_bound(double bound)
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
-  bound_ = bound;
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+             "Cannot change the bound of an exec after its start");
+  kernel::actor::simcall(
+      [this, bound] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bound(bound); });
   return this;
 }
+
+/** @brief  Change the execution priority, don't you think?
+ *
+ * An execution with twice the priority will get twice the amount of flops when the resource is shared.
+ * The default priority is 1.
+ *
+ * Currently, this cannot be changed once the exec started. */
+ExecPtr Exec::set_priority(double priority)
+{
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+             "Cannot change the priority of an exec after its start");
+  kernel::actor::simcall([this, priority] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_sharing_penalty(1. / priority);
+  });
+  return this;
+}
+
 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
-  timeout_ = timeout;
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+             "Cannot change the bound of an exec after its start");
+  kernel::actor::simcall(
+      [this, timeout] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_timeout(timeout); });
   return this;
 }
 
 ExecPtr Exec::set_flops_amount(double flops_amount)
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the flop_amount of an exec after its start");
-  flops_amounts_.assign(1, flops_amount);
-  Activity::set_remaining(flops_amounts_.front());
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+      "Cannot change the flop_amount of an exec after its start");
+  kernel::actor::simcall([this, flops_amount] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
+  });
+  Activity::set_remaining(flops_amount);
   return this;
 }
 
 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the flops_amounts of an exec after its start");
-  flops_amounts_ = flops_amounts;
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+      "Cannot change the flops_amounts of an exec after its start");
+  kernel::actor::simcall([this, flops_amounts] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
+  });
   parallel_      = true;
   return this;
 }
 
 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the bytes_amounts of an exec after its start");
-  bytes_amounts_ = bytes_amounts;
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+      "Cannot change the bytes_amounts of an exec after its start");
+  kernel::actor::simcall([this, bytes_amounts] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
+  });
   parallel_      = true;
   return this;
 }
@@ -111,78 +177,47 @@ unsigned int Exec::get_host_number() const
 {
   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 }
-double Exec::get_start_time() const
-{
-  return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
-}
-double Exec::get_finish_time() const
-{
-  return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
-}
-double Exec::get_cost() const
-{
-  return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
-}
-
-/** @brief  Change the execution priority, don't you think?
- *
- * An execution with twice the priority will get twice the amount of flops when the resource is shared.
- * The default priority is 1.
- *
- * Currently, this cannot be changed once the exec started. */
-ExecPtr Exec::set_priority(double priority)
-{
-  xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
-  priority_ = priority;
-  return this;
-}
 
 /** @brief Change the host on which this activity takes place.
  *
  * The activity cannot be terminated already (but it may be started). */
 ExecPtr Exec::set_host(Host* host)
 {
-  xbt_assert(state_ == State::INITED || state_ == State::STARTED,
-             "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
+             "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_));
+
   if (state_ == State::STARTED)
     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
-  boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
+
+  kernel::actor::simcall(
+      [this, host] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host); });
+
+  if (state_ == State::STARTING)
+  // Setting the host may allow to start the activity, let's try
+    vetoable_start();
+
   return this;
 }
 
 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
-  hosts_    = hosts;
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+             "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
+
+  kernel::actor::simcall(
+      [this, hosts] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_hosts(hosts); });
   parallel_ = true;
+
+  // Setting the host may allow to start the activity, let's try
+  if (state_ == State::STARTING)
+     vetoable_start();
+
   return this;
 }
 
-///////////// SEQUENTIAL EXECUTIONS ////////
-Exec* Exec::start()
+double Exec::get_cost() const
 {
-  if (is_parallel())
-    kernel::actor::simcall([this] {
-      (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
-          .set_hosts(hosts_)
-          .set_timeout(timeout_)
-          .set_flops_amounts(flops_amounts_)
-          .set_bytes_amounts(bytes_amounts_)
-          .start();
-    });
-  else
-    kernel::actor::simcall([this] {
-      (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
-          .set_name(get_name())
-          .set_tracing_category(get_tracing_category())
-          .set_sharing_penalty(1. / priority_)
-          .set_bound(bound_)
-          .set_flops_amount(flops_amounts_.front())
-          .start();
-    });
-  state_ = State::STARTED;
-  on_start(*Actor::self(), *this);
-  return this;
+  return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 }
 
 double Exec::get_remaining() const
@@ -209,8 +244,13 @@ double Exec::get_remaining_ratio() const
         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 }
 
+bool Exec::is_assigned() const
+{
+  return not boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_hosts().empty();
+}
 } // namespace s4u
 } // namespace simgrid
+
 /* **************************** Public C interface *************************** */
 void sg_exec_set_bound(sg_exec_t exec, double bound)
 {
@@ -244,7 +284,7 @@ double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
 
 void sg_exec_start(sg_exec_t exec)
 {
-  exec->start();
+  exec->vetoable_start();
 }
 
 void sg_exec_cancel(sg_exec_t exec)
@@ -265,8 +305,9 @@ sg_error_t sg_exec_wait(sg_exec_t exec)
 {
   sg_error_t status = SG_OK;
 
+  simgrid::s4u::ExecPtr s4u_exec(exec, false);
   try {
-    exec->wait_for(-1);
+    s4u_exec->wait_for(-1);
   } catch (const simgrid::TimeoutException&) {
     status = SG_ERROR_TIMEOUT;
   } catch (const simgrid::CancelException&) {
@@ -274,15 +315,16 @@ sg_error_t sg_exec_wait(sg_exec_t exec)
   } catch (const simgrid::HostFailureException&) {
     status = SG_ERROR_HOST;
   }
-  exec->unref();
   return status;
 }
 
 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
 {
   sg_error_t status = SG_OK;
+
+  simgrid::s4u::ExecPtr s4u_exec(exec, false);
   try {
-    exec->wait_for(timeout);
+    s4u_exec->wait_for(timeout);
   } catch (const simgrid::TimeoutException&) {
     status = SG_ERROR_TIMEOUT;
   } catch (const simgrid::CancelException&) {
@@ -290,7 +332,6 @@ sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
   } catch (const simgrid::HostFailureException&) {
     status = SG_ERROR_HOST;
   }
-  exec->unref();
   return status;
 }
 
@@ -302,15 +343,13 @@ int sg_exec_wait_any(sg_exec_t* execs, size_t count)
 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
 {
   std::vector<simgrid::s4u::ExecPtr> s4u_execs;
-  for (unsigned int i = 0; i < count; i++) {
-    s4u_execs.emplace_back(execs[i]);
-  }
-  int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
-  if (pos != -1)
-    s4u_execs[pos]->unref();
-  else
-    for (const auto& e : s4u_execs)
-      e->unref();
+  for (unsigned int i = 0; i < count; i++)
+    s4u_execs.emplace_back(execs[i], false);
 
+  int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
+  for (unsigned i = 0; i < count; i++) {
+    if (pos != -1 && static_cast<unsigned>(pos) != i)
+      s4u_execs[i]->add_ref();
+  }
   return pos;
 }