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     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   return simcall_execution_waitany_for(rexecs.get(), execs->size(), timeout);
  64 }
  65
  66 Exec* Exec::cancel()
  67 {
  68   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
  69   state_ = State::CANCELED;
  70   return this;
  71 }
  72
  73 /** @brief change the execution bound
  74  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  75  * deliver. Currently, this cannot be changed once the exec started.
  76  */
  77 ExecPtr Exec::set_bound(double bound)
  78 {
  79   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  80   bound_ = bound;
  81   return this;
  82 }
  83 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
  84 {
  85   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  86   timeout_ = timeout;
  87   return this;
  88 }
  89
  90 /** @brief Retrieve the host on which this activity takes place.
  91  *  If it runs on more than one host, only the first host is returned.
  92  */
  93 Host* Exec::get_host() const
  94 {
  95   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
  96 }
  97 unsigned int Exec::get_host_number() const
  98 {
  99   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 100 }
 101 double Exec::get_start_time() const
 102 {
 103   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_start_time();
 104 }
 105 double Exec::get_finish_time() const
 106 {
 107   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
 108 }
 109 double Exec::get_cost() const
 110 {
 111   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 112 }
 113
 114 /** @brief  Change the execution priority, don't you think?
 115  *
 116  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
 117  * The default priority is 1.
 118  *
 119  * Currently, this cannot be changed once the exec started. */
 120 ExecPtr Exec::set_priority(double priority)
 121 {
 122   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
 123   priority_ = priority;
 124   return this;
 125 }
 126
 127 ///////////// SEQUENTIAL EXECUTIONS ////////
 128 ExecSeq::ExecSeq(sg_host_t host, double flops_amount) : Exec(), flops_amount_(flops_amount)
 129 {
 130   Activity::set_remaining(flops_amount_);
 131   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 132 }
 133
 134 Exec* ExecSeq::start()
 135 {
 136   kernel::actor::simcall([this] {
 137     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 138         .set_name(get_name())
 139         .set_tracing_category(get_tracing_category())
 140         .set_sharing_penalty(1. / priority_)
 141         .set_bound(bound_)
 142         .set_flops_amount(flops_amount_)
 143         .start();
 144   });
 145   state_ = State::STARTED;
 146   on_start(*Actor::self(), *this);
 147   return this;
 148 }
 149
 150 /** @brief Returns whether the state of the exec is finished */
 151 /** @brief Change the host on which this activity takes place.
 152  *
 153  * The activity cannot be terminated already (but it may be started). */
 154 ExecPtr ExecSeq::set_host(Host* host)
 155 {
 156   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
 157              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
 158   if (state_ == State::STARTED)
 159     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 160   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 161   return this;
 162 }
 163
 164 /** @brief Returns the amount of flops that remain to be done */
 165 double ExecSeq::get_remaining()
 166 {
 167   return kernel::actor::simcall(
 168       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 169 }
 170
 171 /** @brief Returns the ratio of elements that are still to do
 172  *
 173  * The returned value is between 0 (completely done) and 1 (nothing done yet).
 174  */
 175 double ExecSeq::get_remaining_ratio()
 176 {
 177   return kernel::actor::simcall(
 178       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 179 }
 180
 181 ///////////// PARALLEL EXECUTIONS ////////
 182 ExecPar::ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 183                  const std::vector<double>& bytes_amounts)
 184     : Exec(), hosts_(hosts), flops_amounts_(flops_amounts), bytes_amounts_(bytes_amounts)
 185 {
 186 }
 187
 188 Exec* ExecPar::start()
 189 {
 190   kernel::actor::simcall([this] {
 191     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 192         .set_hosts(hosts_)
 193         .set_timeout(timeout_)
 194         .set_flops_amounts(flops_amounts_)
 195         .set_bytes_amounts(bytes_amounts_)
 196         .start();
 197   });
 198   state_ = State::STARTED;
 199   on_start(*Actor::self(), *this);
 200   return this;
 201 }
 202
 203 double ExecPar::get_remaining_ratio()
 204 {
 205   return kernel::actor::simcall(
 206       [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
 207 }
 208
 209 double ExecPar::get_remaining()
 210 {
 211   XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
 212   return get_remaining_ratio();
 213 }
 214 } // namespace s4u
 215 } // namespace simgrid