Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
setter function only need a simcall in MC or with parallel execs
[simgrid.git] / src / s4u / s4u_Exec.cpp
index 9d1a552..2494698 100644 (file)
@@ -1,80 +1,70 @@
-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2022. 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/exec.h"
-#include "simgrid/s4u/Actor.hpp"
-#include "simgrid/s4u/Exec.hpp"
+#include "simgrid/simix.hpp"
+#include <simgrid/Exception.hpp>
+#include <simgrid/exec.h>
+#include <simgrid/s4u/Exec.hpp>
+#include <simgrid/s4u/Host.hpp>
+
 #include "src/kernel/activity/ExecImpl.hpp"
 #include "src/kernel/actor/ActorImpl.hpp"
-#include "src/mc/checker/SimcallObserver.hpp"
-#include "xbt/log.h"
+#include "src/kernel/actor/SimcallObserver.hpp"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 xbt::signal<void(Exec const&)> Exec::on_start;
-xbt::signal<void(Exec const&)> Exec::on_completion;
 
 Exec::Exec(kernel::activity::ExecImplPtr pimpl)
 {
   pimpl_ = pimpl;
 }
 
-ExecPtr Exec::init()
+void Exec::reset() const
 {
-  auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
-  return ExecPtr(pimpl->get_iface());
+  boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->reset();
 }
 
-Exec* Exec::wait()
+ExecPtr Exec::init()
 {
-  return this->wait_for(-1);
+  auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
+  unsigned int cb_id = Host::on_state_change.connect([pimpl](s4u::Host const& h) {
+    if (not h.is_on() && pimpl->get_state() == kernel::activity::State::RUNNING &&
+        std::find(pimpl->get_hosts().begin(), pimpl->get_hosts().end(), &h) != pimpl->get_hosts().end()) {
+      pimpl->set_state(kernel::activity::State::FAILED);
+      pimpl->post();
+    }
+  });
+  pimpl->set_cb_id(cb_id);
+  return ExecPtr(static_cast<Exec*>(pimpl->get_iface()));
 }
 
-Exec* Exec::wait_for(double timeout)
+Exec* Exec::start()
 {
-  if (state_ == State::INITED)
-    vetoable_start();
-
-  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
-  kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
-  state_ = State::FINISHED;
-  on_completion(*this);
-  this->release_dependencies();
-  return this;
-}
+  kernel::actor::simcall_answered([this] {
+    (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
+        .set_name(get_name())
+        .set_tracing_category(get_tracing_category())
+        .start();
+  });
 
-int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
-{
-  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()); });
+  if (suspended_)
+    pimpl_->suspend();
 
-  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
-  mc::ExecutionWaitanySimcall observer{issuer, &rexecs, timeout};
-  kernel::actor::simcall_blocking<void>(
-      [&observer] {
-        kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(), observer.get_timeout());
-      },
-      &observer);
-  int changed_pos = observer.get_result();
-  if (changed_pos != -1) {
-    on_completion(*(execs->at(changed_pos)));
-    execs->at(changed_pos)->release_dependencies();
-  }
-  return changed_pos;
+  state_      = State::STARTED;
+  on_start(*this);
+  return this;
 }
 
-Exec* Exec::cancel()
+ssize_t Exec::wait_any_for(const std::vector<ExecPtr>& execs, double timeout)
 {
-  kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
-  state_ = State::CANCELED;
-  on_completion(*this);
-  return this;
+  std::vector<ActivityPtr> activities;
+  for (const auto& exec : execs)
+    activities.push_back(boost::dynamic_pointer_cast<Activity>(exec));
+  return Activity::wait_any_for(activities, timeout);
 }
 
 /** @brief change the execution bound
@@ -84,15 +74,34 @@ Exec* Exec::cancel()
 ExecPtr Exec::set_bound(double bound)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
-      "Cannot change the bound of an exec after its start");
-  bound_ = bound;
+             "Cannot change the bound of an exec after its start");
+  kernel::actor::simcall_object_access(pimpl_.get(), [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_object_access(pimpl_.get(), [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
+
+ExecPtr Exec::update_priority(double priority)
 {
-  xbt_assert(state_ == State::INITED|| state_ == State::STARTING,
-      "Cannot change the bound of an exec after its start");
-  timeout_ = timeout;
+  kernel::actor::simcall_answered([this, priority] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->update_sharing_penalty(1. / priority);
+  });
   return this;
 }
 
@@ -100,8 +109,10 @@ ExecPtr Exec::set_flops_amount(double flops_amount)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
       "Cannot change the flop_amount of an exec after its start");
-  flops_amounts_.assign(1, flops_amount);
-  Activity::set_remaining(flops_amounts_.front());
+  kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amount] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
+  });
+  set_remaining(flops_amount);
   return this;
 }
 
@@ -109,7 +120,9 @@ ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
       "Cannot change the flops_amounts of an exec after its start");
-  flops_amounts_ = flops_amounts;
+  kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amounts] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
+  });
   parallel_      = true;
   return this;
 }
@@ -118,11 +131,23 @@ ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
       "Cannot change the bytes_amounts of an exec after its start");
-  bytes_amounts_ = bytes_amounts;
+  kernel::actor::simcall_object_access(pimpl_.get(), [this, bytes_amounts] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
+  });
   parallel_      = true;
   return this;
 }
 
+ExecPtr Exec::set_thread_count(int thread_count)
+{
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+             "Cannot change the bytes_amounts of an exec after its start");
+  kernel::actor::simcall_object_access(pimpl_.get(), [this, thread_count] {
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_thread_count(thread_count);
+  });
+  return this;
+}
+
 /** @brief Retrieve the host on which this activity takes place.
  *  If it runs on more than one host, only the first host is returned.
  */
@@ -134,22 +159,10 @@ unsigned int Exec::get_host_number() const
 {
   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 }
-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)
+int Exec::get_thread_count() const
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
-  priority_ = priority;
-  return this;
+  return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_thread_count();
 }
 
 /** @brief Change the host on which this activity takes place.
@@ -158,13 +171,13 @@ ExecPtr Exec::set_priority(double priority)
 ExecPtr Exec::set_host(Host* host)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
-             "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
-  hosts_.assign(1, host);
+             "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_object_access(
+      pimpl_.get(), [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
@@ -176,9 +189,11 @@ ExecPtr Exec::set_host(Host* host)
 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 {
   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
-      "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
+             "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
 
-  hosts_    = hosts;
+  kernel::actor::simcall_object_access(pimpl_.get(), [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
@@ -188,35 +203,25 @@ ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
   return this;
 }
 
-Exec* Exec::start()
+ExecPtr Exec::unset_host()
 {
-  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();
-    });
+  if (not is_assigned())
+    throw std::invalid_argument(
+        xbt::string_printf("Exec %s: the activity is not assigned to any host(s)", get_cname()));
+  else {
+    reset();
 
-  if (suspended_)
-    pimpl_->suspend();
+    if (state_ == State::STARTED)
+      cancel();
+    vetoable_start();
 
-  state_ = State::STARTED;
-  start_time_ = pimpl_->surf_action_->get_start_time();
-  on_start(*this);
-  return this;
+    return this;
+  }
+}
+
+double Exec::get_cost() const
+{
+  return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 }
 
 double Exec::get_remaining() const
@@ -225,7 +230,7 @@ double Exec::get_remaining() const
     XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
     return get_remaining_ratio();
   } else
-    return kernel::actor::simcall(
+    return kernel::actor::simcall_answered(
         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 }
 
@@ -236,15 +241,18 @@ double Exec::get_remaining() const
 double Exec::get_remaining_ratio() const
 {
   if (is_parallel())
-    return kernel::actor::simcall(
+    return kernel::actor::simcall_answered(
         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
   else
-    return kernel::actor::simcall(
+    return kernel::actor::simcall_answered(
         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 }
 
-} // namespace s4u
-} // namespace simgrid
+bool Exec::is_assigned() const
+{
+  return not boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_hosts().empty();
+}
+} // namespace simgrid::s4u
 
 /* **************************** Public C interface *************************** */
 void sg_exec_set_bound(sg_exec_t exec, double bound)
@@ -298,19 +306,7 @@ int sg_exec_test(sg_exec_t exec)
 
 sg_error_t sg_exec_wait(sg_exec_t exec)
 {
-  sg_error_t status = SG_OK;
-
-  simgrid::s4u::ExecPtr s4u_exec(exec, false);
-  try {
-    s4u_exec->wait_for(-1);
-  } catch (const simgrid::TimeoutException&) {
-    status = SG_ERROR_TIMEOUT;
-  } catch (const simgrid::CancelException&) {
-    status = SG_ERROR_CANCELED;
-  } catch (const simgrid::HostFailureException&) {
-    status = SG_ERROR_HOST;
-  }
-  return status;
+  return sg_exec_wait_for(exec, -1.0);
 }
 
 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
@@ -321,6 +317,7 @@ sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
   try {
     s4u_exec->wait_for(timeout);
   } catch (const simgrid::TimeoutException&) {
+    s4u_exec->add_ref(); // the wait_for timeouted, keep the exec alive
     status = SG_ERROR_TIMEOUT;
   } catch (const simgrid::CancelException&) {
     status = SG_ERROR_CANCELED;
@@ -330,20 +327,20 @@ sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
   return status;
 }
 
-int sg_exec_wait_any(sg_exec_t* execs, size_t count)
+ssize_t sg_exec_wait_any(sg_exec_t* execs, size_t count)
 {
-  return sg_exec_wait_any_for(execs, count, -1);
+  return sg_exec_wait_any_for(execs, count, -1.0);
 }
 
-int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
+ssize_t 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++)
+  for (size_t 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)
+  ssize_t pos = simgrid::s4u::Exec::wait_any_for(s4u_execs, timeout);
+  for (size_t i = 0; i < count; i++) {
+    if (pos != -1 && static_cast<size_t>(pos) != i)
       s4u_execs[i]->add_ref();
   }
   return pos;