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_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 /** @brief Change the host on which this activity takes place.
 146  *
 147  * The activity cannot be terminated already (but it may be started). */
 148 ExecPtr Exec::set_host(Host* host)
 149 {
 150   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
 151              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
 152   if (state_ == State::STARTED)
 153     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 154   boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host);
 155   return this;
 156 }
 157
 158 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 159 {
 160   xbt_assert(state_ == State::INITED, "Cannot change the hosts of an exec once it's done (state: %d)", (int)state_);
 161   hosts_    = hosts;
 162   parallel_ = true;
 163   return this;
 164 }
 165
 166 ///////////// SEQUENTIAL EXECUTIONS ////////
 167 Exec* Exec::start()
 168 {
 169   if (is_parallel())
 170     kernel::actor::simcall([this] {
 171       (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 172           .set_hosts(hosts_)
 173           .set_timeout(timeout_)
 174           .set_flops_amounts(flops_amounts_)
 175           .set_bytes_amounts(bytes_amounts_)
 176           .start();
 177     });
 178   else
 179     kernel::actor::simcall([this] {
 180       (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
 181           .set_name(get_name())
 182           .set_tracing_category(get_tracing_category())
 183           .set_sharing_penalty(1. / priority_)
 184           .set_bound(bound_)
 185           .set_flops_amount(flops_amounts_.front())
 186           .start();
 187     });
 188
 189   if (suspended_)
 190     pimpl_->suspend();
 191
 192   state_ = State::STARTED;
 193   on_start(*this);
 194   return this;
 195 }
 196
 197 double Exec::get_remaining() const
 198 {
 199   if (is_parallel()) {
 200     XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
 201     return get_remaining_ratio();
 202   } else
 203     return kernel::actor::simcall(
 204         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 205 }
 206
 207 /** @brief Returns the ratio of elements that are still to do
 208  *
 209  * The returned value is between 0 (completely done) and 1 (nothing done yet).
 210  */
 211 double Exec::get_remaining_ratio() const
 212 {
 213   if (is_parallel())
 214     return kernel::actor::simcall(
 215         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
 216   else
 217     return kernel::actor::simcall(
 218         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 219 }
 220
 221 } // namespace s4u
 222 } // namespace simgrid
 223 /* **************************** Public C interface *************************** */
 224 void sg_exec_set_bound(sg_exec_t exec, double bound)
 225 {
 226   exec->set_bound(bound);
 227 }
 228
 229 const char* sg_exec_get_name(const_sg_exec_t exec)
 230 {
 231   return exec->get_cname();
 232 }
 233
 234 void sg_exec_set_name(sg_exec_t exec, const char* name)
 235 {
 236   exec->set_name(name);
 237 }
 238
 239 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
 240 {
 241   exec->set_host(new_host);
 242 }
 243
 244 double sg_exec_get_remaining(const_sg_exec_t exec)
 245 {
 246   return exec->get_remaining();
 247 }
 248
 249 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
 250 {
 251   return exec->get_remaining_ratio();
 252 }
 253
 254 void sg_exec_start(sg_exec_t exec)
 255 {
 256   exec->start();
 257 }
 258
 259 void sg_exec_cancel(sg_exec_t exec)
 260 {
 261   exec->cancel();
 262   exec->unref();
 263 }
 264
 265 int sg_exec_test(sg_exec_t exec)
 266 {
 267   bool finished = exec->test();
 268   if (finished)
 269     exec->unref();
 270   return finished;
 271 }
 272
 273 sg_error_t sg_exec_wait(sg_exec_t exec)
 274 {
 275   sg_error_t status = SG_OK;
 276
 277   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 278   try {
 279     s4u_exec->wait_for(-1);
 280   } catch (const simgrid::TimeoutException&) {
 281     status = SG_ERROR_TIMEOUT;
 282   } catch (const simgrid::CancelException&) {
 283     status = SG_ERROR_CANCELED;
 284   } catch (const simgrid::HostFailureException&) {
 285     status = SG_ERROR_HOST;
 286   }
 287   return status;
 288 }
 289
 290 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
 291 {
 292   sg_error_t status = SG_OK;
 293
 294   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 295   try {
 296     s4u_exec->wait_for(timeout);
 297   } catch (const simgrid::TimeoutException&) {
 298     status = SG_ERROR_TIMEOUT;
 299   } catch (const simgrid::CancelException&) {
 300     status = SG_ERROR_CANCELED;
 301   } catch (const simgrid::HostFailureException&) {
 302     status = SG_ERROR_HOST;
 303   }
 304   return status;
 305 }
 306
 307 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
 308 {
 309   return sg_exec_wait_any_for(execs, count, -1);
 310 }
 311
 312 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
 313 {
 314   std::vector<simgrid::s4u::ExecPtr> s4u_execs;
 315   for (unsigned int i = 0; i < count; i++)
 316     s4u_execs.emplace_back(execs[i], false);
 317
 318   int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
 319   for (unsigned i = 0; i < count; i++) {
 320     if (pos != -1 && static_cast<unsigned>(pos) != i)
 321       s4u_execs[i]->add_ref();
 322   }
 323   return pos;
 324 }