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