src/s4u/s4u_Exec.cpp

   1 /* Copyright (c) 2006-2021. 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/Exception.hpp"
   7 #include "simgrid/exec.h"
   8 #include "simgrid/s4u/Actor.hpp"
   9 #include "simgrid/s4u/Exec.hpp"
  10 #include "src/kernel/activity/ExecImpl.hpp"
  11 #include "xbt/log.h"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
  14
  15 namespace simgrid {
  16 namespace s4u {
  17 xbt::signal<void(Exec const&)> Exec::on_start;
  18 xbt::signal<void(Exec const&)> Exec::on_completion;
  19
  20 Exec::Exec()
  21 {
  22   pimpl_ = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
  23 }
  24
  25 ExecPtr Exec::init()
  26 {
  27   return ExecPtr(new Exec());
  28 }
  29
  30 Exec* Exec::wait()
  31 {
  32   return this->wait_for(-1);
  33 }
  34
  35 Exec* Exec::wait_for(double timeout)
  36 {
  37   if (state_ == State::INITED)
  38     vetoable_start();
  39
  40   kernel::actor::ActorImpl* issuer = Actor::self()->get_impl();
  41   kernel::actor::simcall_blocking<void>([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
  42   state_ = State::FINISHED;
  43   on_completion(*this);
  44   this->release_dependencies();
  45   return this;
  46 }
  47
  48 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
  49 {
  50   std::vector<kernel::activity::ExecImpl*> rexecs(execs->size());
  51   std::transform(begin(*execs), end(*execs), begin(rexecs),
  52                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
  53
  54   int changed_pos = simcall_execution_waitany_for(rexecs.data(), rexecs.size(), timeout);
  55   if (changed_pos != -1)
  56     execs->at(changed_pos)->release_dependencies();
  57   return changed_pos;
  58 }
  59
  60 Exec* Exec::cancel()
  61 {
  62   kernel::actor::simcall([this] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->cancel(); });
  63   state_ = State::CANCELED;
  64   return this;
  65 }
  66
  67 /** @brief change the execution bound
  68  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  69  * deliver. Currently, this cannot be changed once the exec started.
  70  */
  71 ExecPtr Exec::set_bound(double bound)
  72 {
  73   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  74   bound_ = bound;
  75   return this;
  76 }
  77 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
  78 {
  79   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  80   timeout_ = timeout;
  81   return this;
  82 }
  83
  84 ExecPtr Exec::set_flops_amount(double flops_amount)
  85 {
  86   xbt_assert(state_ == State::INITED, "Cannot change the flop_amount of an exec after its start");
  87   flops_amounts_.assign(1, flops_amount);
  88   Activity::set_remaining(flops_amounts_.front());
  89   return this;
  90 }
  91
  92 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
  93 {
  94   xbt_assert(state_ == State::INITED, "Cannot change the flops_amounts of an exec after its start");
  95   flops_amounts_ = flops_amounts;
  96   parallel_      = true;
  97   return this;
  98 }
  99
 100 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
 101 {
 102   xbt_assert(state_ == State::INITED, "Cannot change the bytes_amounts of an exec after its start");
 103   bytes_amounts_ = bytes_amounts;
 104   parallel_      = true;
 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_finish_time() const
 120 {
 121   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_finish_time();
 122 }
 123 double Exec::get_cost() const
 124 {
 125   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 126 }
 127
 128 /** @brief  Change the execution priority, don't you think?
 129  *
 130  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
 131  * The default priority is 1.
 132  *
 133  * Currently, this cannot be changed once the exec started. */
 134 ExecPtr Exec::set_priority(double priority)
 135 {
 136   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
 137   priority_ = priority;
 138   return this;
 139 }
 140
 141 /** @brief Change the host on which this activity takes place.
 142  *
 143  * The activity cannot be terminated already (but it may be started). */
 144 ExecPtr Exec::set_host(Host* host)
 145 {
 146   xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
 147              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
 148   hosts_.assign(1, host);
 149
 150   if (state_ == State::STARTED)
 151     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 152
 153   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 154
 155   if (state_ == State::STARTING)
 156   // Setting the host may allow to start the activity, let's try
 157     vetoable_start();
 158
 159   return this;
 160 }
 161
 162 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 163 {
 164   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 165       "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
 166
 167   hosts_    = hosts;
 168   parallel_ = true;
 169
 170   // Setting the host may allow to start the activity, let's try
 171   if (state_ == State::STARTING)
 172      vetoable_start();
 173
 174   return this;
 175 }
 176
 177 ///////////// SEQUENTIAL EXECUTIONS ////////
 178 Exec* Exec::start()
 179 {
 180   if (is_parallel())
 181     kernel::actor::simcall([this] {
 182       (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 183           .set_hosts(hosts_)
 184           .set_timeout(timeout_)
 185           .set_flops_amounts(flops_amounts_)
 186           .set_bytes_amounts(bytes_amounts_)
 187           .start();
 188     });
 189   else
 190     kernel::actor::simcall([this] {
 191       (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 192           .set_name(get_name())
 193           .set_tracing_category(get_tracing_category())
 194           .set_sharing_penalty(1. / priority_)
 195           .set_bound(bound_)
 196           .set_flops_amount(flops_amounts_.front())
 197           .start();
 198     });
 199
 200   if (suspended_)
 201     pimpl_->suspend();
 202
 203   state_ = State::STARTED;
 204   start_time_ = pimpl_->surf_action_->get_start_time();
 205   on_start(*this);
 206   return this;
 207 }
 208
 209 double Exec::get_remaining() const
 210 {
 211   if (is_parallel()) {
 212     XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
 213     return get_remaining_ratio();
 214   } else
 215     return kernel::actor::simcall(
 216         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 217 }
 218
 219 /** @brief Returns the ratio of elements that are still to do
 220  *
 221  * The returned value is between 0 (completely done) and 1 (nothing done yet).
 222  */
 223 double Exec::get_remaining_ratio() const
 224 {
 225   if (is_parallel())
 226     return kernel::actor::simcall(
 227         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
 228   else
 229     return kernel::actor::simcall(
 230         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 231 }
 232
 233 } // namespace s4u
 234 } // namespace simgrid
 235 /* **************************** Public C interface *************************** */
 236 void sg_exec_set_bound(sg_exec_t exec, double bound)
 237 {
 238   exec->set_bound(bound);
 239 }
 240
 241 const char* sg_exec_get_name(const_sg_exec_t exec)
 242 {
 243   return exec->get_cname();
 244 }
 245
 246 void sg_exec_set_name(sg_exec_t exec, const char* name)
 247 {
 248   exec->set_name(name);
 249 }
 250
 251 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
 252 {
 253   exec->set_host(new_host);
 254 }
 255
 256 double sg_exec_get_remaining(const_sg_exec_t exec)
 257 {
 258   return exec->get_remaining();
 259 }
 260
 261 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
 262 {
 263   return exec->get_remaining_ratio();
 264 }
 265
 266 void sg_exec_start(sg_exec_t exec)
 267 {
 268   exec->start();
 269 }
 270
 271 void sg_exec_cancel(sg_exec_t exec)
 272 {
 273   exec->cancel();
 274   exec->unref();
 275 }
 276
 277 int sg_exec_test(sg_exec_t exec)
 278 {
 279   bool finished = exec->test();
 280   if (finished)
 281     exec->unref();
 282   return finished;
 283 }
 284
 285 sg_error_t sg_exec_wait(sg_exec_t exec)
 286 {
 287   sg_error_t status = SG_OK;
 288
 289   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 290   try {
 291     s4u_exec->wait_for(-1);
 292   } catch (const simgrid::TimeoutException&) {
 293     status = SG_ERROR_TIMEOUT;
 294   } catch (const simgrid::CancelException&) {
 295     status = SG_ERROR_CANCELED;
 296   } catch (const simgrid::HostFailureException&) {
 297     status = SG_ERROR_HOST;
 298   }
 299   return status;
 300 }
 301
 302 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
 303 {
 304   sg_error_t status = SG_OK;
 305
 306   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 307   try {
 308     s4u_exec->wait_for(timeout);
 309   } catch (const simgrid::TimeoutException&) {
 310     status = SG_ERROR_TIMEOUT;
 311   } catch (const simgrid::CancelException&) {
 312     status = SG_ERROR_CANCELED;
 313   } catch (const simgrid::HostFailureException&) {
 314     status = SG_ERROR_HOST;
 315   }
 316   return status;
 317 }
 318
 319 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
 320 {
 321   return sg_exec_wait_any_for(execs, count, -1);
 322 }
 323
 324 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
 325 {
 326   std::vector<simgrid::s4u::ExecPtr> s4u_execs;
 327   for (unsigned int i = 0; i < count; i++)
 328     s4u_execs.emplace_back(execs[i], false);
 329
 330   int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
 331   for (unsigned i = 0; i < count; i++) {
 332     if (pos != -1 && static_cast<unsigned>(pos) != i)
 333       s4u_execs[i]->add_ref();
 334   }
 335   return pos;
 336 }