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