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