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