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