src/s4u/s4u_Exec.cpp

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