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