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/Exec.hpp>
   9 #include <simgrid/s4u/Host.hpp>
  10
  11 #include "src/kernel/activity/ExecImpl.hpp"
  12 #include "src/kernel/actor/ActorImpl.hpp"
  13 #include "src/kernel/actor/SimcallObserver.hpp"
  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 void Exec::complete(Activity::State state)
  28 {
  29   Activity::complete(state);
  30   on_completion(*this);
  31 }
  32
  33 ExecPtr Exec::init()
  34 {
  35   auto pimpl = kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl());
  36   unsigned int cb_id = Host::on_state_change.connect([pimpl](s4u::Host const& h) {
  37     if (not h.is_on() && pimpl->state_ == kernel::activity::State::RUNNING &&
  38         std::find(pimpl->get_hosts().begin(), pimpl->get_hosts().end(), &h) != pimpl->get_hosts().end()) {
  39       pimpl->state_ = kernel::activity::State::FAILED;
  40       pimpl->post();
  41     }
  42   });
  43   pimpl->set_cb_id(cb_id);
  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::update_priority(double priority)
 112 {
 113   kernel::actor::simcall([this, priority] {
 114     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->update_sharing_penalty(1. / priority);
 115   });
 116   return this;
 117 }
 118
 119 ExecPtr Exec::set_flops_amount(double flops_amount)
 120 {
 121   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 122       "Cannot change the flop_amount of an exec after its start");
 123   kernel::actor::simcall([this, flops_amount] {
 124     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
 125   });
 126   Activity::set_remaining(flops_amount);
 127   return this;
 128 }
 129
 130 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
 131 {
 132   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 133       "Cannot change the flops_amounts of an exec after its start");
 134   kernel::actor::simcall([this, flops_amounts] {
 135     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
 136   });
 137   parallel_      = true;
 138   return this;
 139 }
 140
 141 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
 142 {
 143   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 144       "Cannot change the bytes_amounts of an exec after its start");
 145   kernel::actor::simcall([this, bytes_amounts] {
 146     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
 147   });
 148   parallel_      = true;
 149   return this;
 150 }
 151
 152 /** @brief Retrieve the host on which this activity takes place.
 153  *  If it runs on more than one host, only the first host is returned.
 154  */
 155 Host* Exec::get_host() const
 156 {
 157   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
 158 }
 159 unsigned int Exec::get_host_number() const
 160 {
 161   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 162 }
 163
 164 double Exec::get_start_time() const
 165 {
 166   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_start_time();
 167 }
 168
 169 double Exec::get_finish_time() const
 170 {
 171   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_finish_time();
 172 }
 173
 174 /** @brief Change the host on which this activity takes place.
 175  *
 176  * The activity cannot be terminated already (but it may be started). */
 177 ExecPtr Exec::set_host(Host* host)
 178 {
 179   xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
 180              "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_));
 181
 182   if (state_ == State::STARTED)
 183     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 184
 185   kernel::actor::simcall(
 186       [this, host] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host); });
 187
 188   if (state_ == State::STARTING)
 189   // Setting the host may allow to start the activity, let's try
 190     vetoable_start();
 191
 192   return this;
 193 }
 194
 195 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 196 {
 197   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 198              "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
 199
 200   kernel::actor::simcall(
 201       [this, hosts] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_hosts(hosts); });
 202   parallel_ = true;
 203
 204   // Setting the host may allow to start the activity, let's try
 205   if (state_ == State::STARTING)
 206      vetoable_start();
 207
 208   return this;
 209 }
 210
 211 double Exec::get_cost() const
 212 {
 213   return (pimpl_->surf_action_ == nullptr) ? -1 : pimpl_->surf_action_->get_cost();
 214 }
 215
 216 double Exec::get_remaining() const
 217 {
 218   if (is_parallel()) {
 219     XBT_WARN("Calling get_remaining() on a parallel execution is not allowed. Call get_remaining_ratio() instead.");
 220     return get_remaining_ratio();
 221   } else
 222     return kernel::actor::simcall(
 223         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 224 }
 225
 226 /** @brief Returns the ratio of elements that are still to do
 227  *
 228  * The returned value is between 0 (completely done) and 1 (nothing done yet).
 229  */
 230 double Exec::get_remaining_ratio() const
 231 {
 232   if (is_parallel())
 233     return kernel::actor::simcall(
 234         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_par_remaining_ratio(); });
 235   else
 236     return kernel::actor::simcall(
 237         [this]() { return boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_seq_remaining_ratio(); });
 238 }
 239
 240 bool Exec::is_assigned() const
 241 {
 242   return not boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->get_hosts().empty();
 243 }
 244 } // namespace s4u
 245 } // namespace simgrid
 246
 247 /* **************************** Public C interface *************************** */
 248 void sg_exec_set_bound(sg_exec_t exec, double bound)
 249 {
 250   exec->set_bound(bound);
 251 }
 252
 253 const char* sg_exec_get_name(const_sg_exec_t exec)
 254 {
 255   return exec->get_cname();
 256 }
 257
 258 void sg_exec_set_name(sg_exec_t exec, const char* name)
 259 {
 260   exec->set_name(name);
 261 }
 262
 263 void sg_exec_set_host(sg_exec_t exec, sg_host_t new_host)
 264 {
 265   exec->set_host(new_host);
 266 }
 267
 268 double sg_exec_get_remaining(const_sg_exec_t exec)
 269 {
 270   return exec->get_remaining();
 271 }
 272
 273 double sg_exec_get_remaining_ratio(const_sg_exec_t exec)
 274 {
 275   return exec->get_remaining_ratio();
 276 }
 277
 278 void sg_exec_start(sg_exec_t exec)
 279 {
 280   exec->vetoable_start();
 281 }
 282
 283 void sg_exec_cancel(sg_exec_t exec)
 284 {
 285   exec->cancel();
 286   exec->unref();
 287 }
 288
 289 int sg_exec_test(sg_exec_t exec)
 290 {
 291   bool finished = exec->test();
 292   if (finished)
 293     exec->unref();
 294   return finished;
 295 }
 296
 297 sg_error_t sg_exec_wait(sg_exec_t exec)
 298 {
 299   return sg_exec_wait_for(exec, -1.0);
 300 }
 301
 302 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
 303 {
 304   sg_error_t status = SG_OK;
 305
 306   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 307   try {
 308     s4u_exec->wait_for(timeout);
 309   } catch (const simgrid::TimeoutException&) {
 310     s4u_exec->add_ref(); // the wait_for timeouted, keep the exec alive
 311     status = SG_ERROR_TIMEOUT;
 312   } catch (const simgrid::CancelException&) {
 313     status = SG_ERROR_CANCELED;
 314   } catch (const simgrid::HostFailureException&) {
 315     status = SG_ERROR_HOST;
 316   }
 317   return status;
 318 }
 319
 320 ssize_t sg_exec_wait_any(sg_exec_t* execs, size_t count)
 321 {
 322   return sg_exec_wait_any_for(execs, count, -1.0);
 323 }
 324
 325 ssize_t sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
 326 {
 327   std::vector<simgrid::s4u::ExecPtr> s4u_execs;
 328   for (size_t i = 0; i < count; i++)
 329     s4u_execs.emplace_back(execs[i], false);
 330
 331   ssize_t pos = simgrid::s4u::Exec::wait_any_for(s4u_execs, timeout);
 332   for (size_t i = 0; i < count; i++) {
 333     if (pos != -1 && static_cast<size_t>(pos) != i)
 334       s4u_execs[i]->add_ref();
 335   }
 336   return pos;
 337 }