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