src/s4u/s4u_Exec.cpp

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