src/s4u/s4u_Exec.cpp

   1 /* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/s4u/Actor.hpp"
   7 #include "simgrid/s4u/Exec.hpp"
   8 #include "src/kernel/activity/ExecImpl.hpp"
   9 #include "xbt/log.h"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
  12
  13 namespace simgrid {
  14 namespace s4u {
  15 xbt::signal<void(Actor const&, Exec const&)> Exec::on_start;
  16 xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion;
  17
  18 Exec::Exec()
  19 {
  20   pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
  21 }
  22
  23 bool Exec::test()
  24 {
  25   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
  26              state_ == State::FINISHED);
  27
  28   if (state_ == State::FINISHED)
  29     return true;
  30
  31   if (state_ == State::INITED || state_ == State::STARTING)
  32     this->vetoable_start();
  33
  34   if (simcall_execution_test(get_impl())) {
  35     state_ = State::FINISHED;
  36     this->release_dependencies();
  37     return true;
  38   }
  39
  40   return false;
  41 }
  42
  43 Exec* Exec::wait()
  44 {
  45   return this->wait_for(-1);
  46 }
  47
  48 Exec* Exec::wait_for(double timeout)
  49 {
  50   if (state_ == State::INITED)
  51     vetoable_start();
  52   simcall_execution_wait(get_impl(), timeout);
  53   state_ = State::FINISHED;
  54   on_completion(*Actor::self(), *this);
  55   this->release_dependencies();
  56   return this;
  57 }
  58
  59 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
  60 {
  61   std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
  62   std::transform(begin(*execs), end(*execs), rexecs.get(),
  63                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
  64
  65   int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
  66   if (changed_pos != -1)
  67     execs->at(changed_pos)->release_dependencies();
  68   return changed_pos;
  69 }
  70
  71 Exec* Exec::cancel()
  72 {
  73   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
  74   state_ = State::CANCELED;
  75   return this;
  76 }
  77
  78 /** @brief change the execution bound
  79  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  80  * deliver. Currently, this cannot be changed once the exec started.
  81  */
  82 ExecPtr Exec::set_bound(double bound)
  83 {
  84   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  85   bound_ = bound;
  86   return this;
  87 }
  88 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
  89 {
  90   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  91   timeout_ = timeout;
  92   return this;
  93 }
  94
  95 /** @brief Retrieve the host on which this activity takes place.
  96  *  If it runs on more than one host, only the first host is returned.
  97  */
  98 Host* Exec::get_host() const
  99 {
 100   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
 101 }
 102 unsigned int Exec::get_host_number() const
 103 {
 104   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 105 }
 106 double Exec::get_start_time() const
 107 {
 108   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
 109 }
 110 double Exec::get_finish_time() const
 111 {
 112   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
 113 }
 114 double Exec::get_cost() const
 115 {
 116   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 117 }
 118
 119 /** @brief  Change the execution priority, don't you think?
 120  *
 121  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
 122  * The default priority is 1.
 123  *
 124  * Currently, this cannot be changed once the exec started. */
 125 ExecPtr Exec::set_priority(double priority)
 126 {
 127   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
 128   priority_ = priority;
 129   return this;
 130 }
 131
 132 ///////////// SEQUENTIAL EXECUTIONS ////////
 133 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
 134 {
 135   Activity::set_remaining(flops_amount_);
 136   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 137 }
 138
 139 Exec* ExecSeq::start()
 140 {
 141   kernel::actor::simcall([this] {
 142     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 143         .set_name(get_name())
 144         .set_tracing_category(get_tracing_category())
 145         .set_sharing_penalty(1. / priority_)
 146         .set_bound(bound_)
 147         .set_flops_amount(flops_amount_)
 148         .start();
 149   });
 150   state_ = State::STARTED;
 151   on_start(*Actor::self(), *this);
 152   return this;
 153 }
 154
 155 /** @brief Returns whether the state of the exec is finished */
 156 /** @brief Change the host on which this activity takes place.
 157  *
 158  * The activity cannot be terminated already (but it may be started). */
 159 ExecPtr ExecSeq::set_host(Host* host)
 160 {
 161   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
 162              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
 163   if (state_ == State::STARTED)
 164     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 165   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 166   return this;
 167 }
 168
 169 double ExecSeq::get_remaining() const
 170 {
 171   return kernel::actor::simcall(
 172       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 173 }
 174
 175 /** @brief Returns the ratio of elements that are still to do
 176  *
 177  * The returned value is between 0 (completely done) and 1 (nothing done yet).
 178  */
 179 double ExecSeq::get_remaining_ratio() const
 180 {
 181   return kernel::actor::simcall(
 182       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 183 }
 184
 185 ///////////// PARALLEL EXECUTIONS ////////
 186 ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 187                  const std::vector<double>& bytes_amounts)
 188     : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
 189 {
 190 }
 191
 192 Exec* ExecPar::start()
 193 {
 194   kernel::actor::simcall([this] {
 195     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 196         .set_hosts(hosts_)
 197         .set_timeout(timeout_)
 198         .set_flops_amounts(flops_amounts_)
 199         .set_bytes_amounts(bytes_amounts_)
 200         .start();
 201   });
 202   state_ = State::STARTED;
 203   on_start(*Actor::self(), *this);
 204   return this;
 205 }
 206
 207 double ExecPar::get_remaining_ratio() const
 208 {
 209   return kernel::actor::simcall(
 210       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
 211 }
 212
 213 double ExecPar::get_remaining() const
 214 {
 215   XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
 216   return get_remaining_ratio();
 217 }
 218 } // namespace s4u
 219 } // namespace simgrid