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(pimpl_)) {
  35     state_ = State::FINISHED;
  36     return true;
  37   }
  38
  39   return false;
  40 }
  41
  42 Exec* Exec::wait()
  43 {
  44   return this->wait_for(-1);
  45 }
  46
  47 Exec* Exec::wait_for(double timeout)
  48 {
  49   if (state_ == State::INITED)
  50     vetoable_start();
  51   simcall_execution_wait(pimpl_, timeout);
  52   state_ = State::FINISHED;
  53   on_completion(*Actor::self(), *this);
  54   this->release_dependencies();
  55   return this;
  56 }
  57
  58 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
  59 {
  60   std::unique_ptr<kernel::activity::ExecImpl* []> rexecs(new kernel::activity::ExecImpl*[execs->size()]);
  61   std::transform(begin(*execs), end(*execs), rexecs.get(),
  62                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
  63
  64   int changed_pos = simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
  65   if (changed_pos != -1)
  66     execs->at(changed_pos)->release_dependencies();
  67   return changed_pos;
  68 }
  69
  70 Exec* Exec::cancel()
  71 {
  72   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
  73   state_ = State::CANCELED;
  74   return this;
  75 }
  76
  77 /** @brief change the execution bound
  78  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  79  * deliver. Currently, this cannot be changed once the exec started.
  80  */
  81 ExecPtr Exec::set_bound(double bound)
  82 {
  83   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  84   bound_ = bound;
  85   return this;
  86 }
  87 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
  88 {
  89   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  90   timeout_ = timeout;
  91   return this;
  92 }
  93
  94 /** @brief Retrieve the host on which this activity takes place.
  95  *  If it runs on more than one host, only the first host is returned.
  96  */
  97 Host* Exec::get_host() const
  98 {
  99   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
 100 }
 101 unsigned int Exec::get_host_number() const
 102 {
 103   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 104 }
 105 double Exec::get_start_time() const
 106 {
 107   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
 108 }
 109 double Exec::get_finish_time() const
 110 {
 111   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
 112 }
 113 double Exec::get_cost() const
 114 {
 115   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 116 }
 117
 118 /** @brief  Change the execution priority, don't you think?
 119  *
 120  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
 121  * The default priority is 1.
 122  *
 123  * Currently, this cannot be changed once the exec started. */
 124 ExecPtr Exec::set_priority(double priority)
 125 {
 126   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
 127   priority_ = priority;
 128   return this;
 129 }
 130
 131 ///////////// SEQUENTIAL EXECUTIONS ////////
 132 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
 133 {
 134   Activity::set_remaining(flops_amount_);
 135   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 136 }
 137
 138 Exec* ExecSeq::start()
 139 {
 140   kernel::actor::simcall([this] {
 141     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 142         .set_name(get_name())
 143         .set_tracing_category(get_tracing_category())
 144         .set_sharing_penalty(1. / priority_)
 145         .set_bound(bound_)
 146         .set_flops_amount(flops_amount_)
 147         .start();
 148   });
 149   state_ = State::STARTED;
 150   on_start(*Actor::self(), *this);
 151   return this;
 152 }
 153
 154 /** @brief Returns whether the state of the exec is finished */
 155 /** @brief Change the host on which this activity takes place.
 156  *
 157  * The activity cannot be terminated already (but it may be started). */
 158 ExecPtr ExecSeq::set_host(Host* host)
 159 {
 160   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
 161              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
 162   if (state_ == State::STARTED)
 163     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 164   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 165   return this;
 166 }
 167
 168 /** @brief Returns the amount of flops that remain to be done */
 169 double ExecSeq::get_remaining()
 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()
 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()
 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()
 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