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