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