Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add "const" to some getters of Activities.
[simgrid.git] / src / s4u / s4u_Exec.cpp
index 27ff9fd..72ab238 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2020. 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. */
@@ -12,26 +12,28 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous execut
 
 namespace simgrid {
 namespace s4u {
-xbt::signal<void(ActorPtr)> Exec::on_start;
-xbt::signal<void(ActorPtr)> Exec::on_completion;
+xbt::signal<void(Actor const&, Exec const&)> Exec::on_start;
+xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion;
 
 Exec::Exec()
 {
-  pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl(get_name(), get_tracing_category()));
+  pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
 }
 
 bool Exec::test()
 {
-  xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
+  xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
+             state_ == State::FINISHED);
 
   if (state_ == State::FINISHED)
     return true;
 
-  if (state_ == State::INITED)
-    this->start();
+  if (state_ == State::INITED || state_ == State::STARTING)
+    this->vetoable_start();
 
-  if (simcall_execution_test(pimpl_)) {
+  if (simcall_execution_test(get_impl())) {
     state_ = State::FINISHED;
+    this->release_dependencies();
     return true;
   }
 
@@ -39,40 +41,40 @@ bool Exec::test()
 }
 
 Exec* Exec::wait()
+{
+  return this->wait_for(-1);
+}
+
+Exec* Exec::wait_for(double timeout)
 {
   if (state_ == State::INITED)
-    start();
-  simcall_execution_wait(pimpl_);
+    vetoable_start();
+  simcall_execution_wait(get_impl(), timeout);
   state_ = State::FINISHED;
-  on_completion(Actor::self());
+  on_completion(*Actor::self(), *this);
+  this->release_dependencies();
   return this;
 }
 
-Exec* Exec::wait_for(double)
+int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
 {
-  THROW_UNIMPLEMENTED;
+  std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
+  std::transform(begin(*execs), end(*execs), rexecs.get(),
+                 [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
+
+  int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
+  if (changed_pos != -1)
+    execs->at(changed_pos)->release_dependencies();
+  return changed_pos;
 }
 
 Exec* Exec::cancel()
 {
-  simix::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
+  kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
   state_ = State::CANCELED;
   return this;
 }
 
-void intrusive_ptr_release(simgrid::s4u::Exec* e)
-{
-  if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
-    std::atomic_thread_fence(std::memory_order_acquire);
-    delete e;
-  }
-}
-
-void intrusive_ptr_add_ref(simgrid::s4u::Exec* e)
-{
-  e->refcount_.fetch_add(1, std::memory_order_relaxed);
-}
-
 /** @brief change the execution bound
  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  * deliver. Currently, this cannot be changed once the exec started.
@@ -83,13 +85,37 @@ ExecPtr Exec::set_bound(double bound)
   bound_ = bound;
   return this;
 }
-ExecPtr Exec::set_timeout(double timeout)
+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;
   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.
+ */
+Host* Exec::get_host() const
+{
+  return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
+}
+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.
@@ -107,16 +133,22 @@ ExecPtr Exec::set_priority(double priority)
 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
 {
   Activity::set_remaining(flops_amount_);
-  boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->set_host(host);
+  boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 }
 
 Exec* ExecSeq::start()
 {
-  simix::simcall([this] {
-    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->start(flops_amount_, 1. / priority_, bound_);
+  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());
+  on_start(*Actor::self(), *this);
   return this;
 }
 
@@ -129,35 +161,25 @@ ExecPtr ExecSeq::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_);
   if (state_ == State::STARTED)
-    boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->migrate(host);
-  host_ = host;
-  boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->host_ = host;
+    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
+  boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
   return this;
 }
 
-
-/** @brief Retrieve the host on which this activity takes place. */
-Host* ExecSeq::get_host()
+double ExecSeq::get_remaining() const
 {
-  return host_;
+  return kernel::actor::simcall(
+      [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 }
 
-/** @brief Returns the amount of flops that remain to be done */
-double ExecSeq::get_remaining()
-{
-  return simgrid::simix::simcall(
-      [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
-}
-
-/** @brief Returns the ratio of elements that are still to do
+/** @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 ExecSeq::get_remaining_ratio() const
 {
-  return simgrid::simix::simcall([this]() {
-    return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio();
-  });
+  return kernel::actor::simcall(
+      [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 }
 
 ///////////// PARALLEL EXECUTIONS ////////
@@ -165,28 +187,30 @@ ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>
                  const std::vector<double>& bytes_amounts)
     : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
 {
-  // For parallel executions, we need a special host to run the timeout detector.
-  host_                                                                          = hosts.front();
-  boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->host_ = host_;
 }
 
 Exec* ExecPar::start()
 {
-  simix::simcall([this] {
-    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_timeout(timeout_);
-    boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->start(hosts_, flops_amounts_, bytes_amounts_);
+  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());
+  on_start(*Actor::self(), *this);
   return this;
 }
-double ExecPar::get_remaining_ratio()
+
+double ExecPar::get_remaining_ratio() const
 {
-  return simix::simcall(
+  return kernel::actor::simcall(
       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
 }
 
-double ExecPar::get_remaining()
+double ExecPar::get_remaining() const
 {
   XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
   return get_remaining_ratio();