Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Handle simcall result through mc::SimcallObserver.
[simgrid.git] / src / s4u / s4u_Exec.cpp
index 0aca559..9d1a552 100644 (file)
@@ -1,41 +1,33 @@
-/* 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. */
 
+#include "simgrid/Exception.hpp"
+#include "simgrid/exec.h"
 #include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "src/kernel/activity/ExecImpl.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
+#include "src/mc/checker/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;
 }
 
-bool Exec::test()
+ExecPtr Exec::init()
 {
-  xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
-
-  if (state_ == State::FINISHED)
-    return true;
-
-  if (state_ == State::INITED)
-    this->start();
-
-  if (simcall_execution_test(pimpl_)) {
-    state_ = State::FINISHED;
-    return true;
-  }
-
-  return false;
+  auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
+  return ExecPtr(pimpl->get_iface());
 }
 
 Exec* Exec::wait()
@@ -46,25 +38,42 @@ Exec* Exec::wait()
 Exec* Exec::wait_for(double timeout)
 {
   if (state_ == State::INITED)
-    start();
-  simcall_execution_wait(pimpl_, timeout);
+    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(*Actor::self(), *this);
+  on_completion(*this);
+  this->release_dependencies();
   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()); });
-  return simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
+
+  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;
 }
 
 Exec* Exec::cancel()
 {
   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
   state_ = State::CANCELED;
+  on_completion(*this);
   return this;
 }
 
@@ -74,17 +83,46 @@ Exec* Exec::cancel()
  */
 ExecPtr Exec::set_bound(double bound)
 {
-  xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+      "Cannot change the bound of an exec after its start");
   bound_ = bound;
   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");
+  xbt_assert(state_ == State::INITED|| state_ == State::STARTING,
+      "Cannot change the bound of an exec after its start");
   timeout_ = timeout;
   return this;
 }
 
+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());
+  return this;
+}
+
+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;
+  parallel_      = true;
+  return this;
+}
+
+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;
+  parallel_      = true;
+  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.
  */
@@ -96,14 +134,6 @@ 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();
@@ -122,92 +152,199 @@ ExecPtr Exec::set_priority(double priority)
   return this;
 }
 
-///////////// SEQUENTIAL EXECUTIONS ////////
-ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
+/** @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)
 {
-  Activity::set_remaining(flops_amount_);
+  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);
+
+  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);
+
+  if (state_ == State::STARTING)
+  // Setting the host may allow to start the activity, let's try
+    vetoable_start();
+
+  return this;
 }
 
-Exec* ExecSeq::start()
+ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 {
-  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_amount_)
-        .start();
-  });
-  state_ = State::STARTED;
-  on_start(*Actor::self(), *this);
+  xbt_assert(state_ == State::INITED || state_ == State::STARTING,
+      "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
+
+  hosts_    = hosts;
+  parallel_ = true;
+
+  // Setting the host may allow to start the activity, let's try
+  if (state_ == State::STARTING)
+     vetoable_start();
+
   return this;
 }
 
-/** @brief Returns whether the state of the exec is finished */
-/** @brief Change the host on which this activity takes place.
- *
- * The activity cannot be terminated already (but it may be started). */
-ExecPtr ExecSeq::set_host(Host* host)
+Exec* Exec::start()
 {
-  xbt_assert(state_ == State::INITED || state_ == State::STARTED,
-             "Cannot change the host of an exec once it's done (state: %d)", (int)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);
+  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 (suspended_)
+    pimpl_->suspend();
+
+  state_ = State::STARTED;
+  start_time_ = pimpl_->surf_action_->get_start_time();
+  on_start(*this);
   return this;
 }
 
-/** @brief Returns the amount of flops that remain to be done */
-double ExecSeq::get_remaining()
+double Exec::get_remaining() const
 {
-  return kernel::actor::simcall(
-      [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
+  if (is_parallel()) {
+    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(
+        [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 }
 
 /** @brief Returns the ratio of elements that are still to do
  *
  * The returned value is between 0 (completely done) and 1 (nothing done yet).
  */
-double ExecSeq::get_remaining_ratio()
+double Exec::get_remaining_ratio() const
 {
-  return kernel::actor::simcall(
-      [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
+  if (is_parallel())
+    return kernel::actor::simcall(
+        [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
+  else
+    return kernel::actor::simcall(
+        [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 }
 
-///////////// PARALLEL EXECUTIONS ////////
-ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
-                 const std::vector<double>& bytes_amounts)
-    : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
+} // namespace s4u
+} // namespace simgrid
+
+/* **************************** Public C interface *************************** */
+void sg_exec_set_bound(sg_exec_t exec, double bound)
 {
+  exec->set_bound(bound);
 }
 
-Exec* ExecPar::start()
+const char* sg_exec_get_name(const_sg_exec_t exec)
 {
-  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();
-  });
-  state_ = State::STARTED;
-  on_start(*Actor::self(), *this);
-  return this;
+  return exec->get_cname();
 }
 
-double ExecPar::get_remaining_ratio()
+void sg_exec_set_name(sg_exec_t exec, const char* name)
 {
-  return kernel::actor::simcall(
-      [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
+  exec->set_name(name);
 }
 
-double ExecPar::get_remaining()
+void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
 {
-  XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
-  return get_remaining_ratio();
+  exec->set_host(new_host);
+}
+
+double sg_exec_get_remaining(const_sg_exec_t exec)
+{
+  return exec->get_remaining();
+}
+
+double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
+{
+  return exec->get_remaining_ratio();
+}
+
+void sg_exec_start(sg_exec_t exec)
+{
+  exec->vetoable_start();
+}
+
+void sg_exec_cancel(sg_exec_t exec)
+{
+  exec->cancel();
+  exec->unref();
+}
+
+int sg_exec_test(sg_exec_t exec)
+{
+  bool finished = exec->test();
+  if (finished)
+    exec->unref();
+  return finished;
+}
+
+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;
+}
+
+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 {
+    s4u_exec->wait_for(timeout);
+  } 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;
+}
+
+int sg_exec_wait_any(sg_exec_t* execs, size_t count)
+{
+  return sg_exec_wait_any_for(execs, count, -1);
+}
+
+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], 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;
 }
-} // namespace s4u
-} // namespace simgrid