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/kernel/actor/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 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   return ExecPtr(pimpl->get_iface());
  37 }
  38
  39 Exec* Exec::start()
  40 {
  41   kernel::actor::simcall([this] {
  42     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
  43         .set_name(get_name())
  44         .set_tracing_category(get_tracing_category())
  45         .start();
  46   });
  47
  48   if (suspended_)
  49     pimpl_->suspend();
  50
  51   state_      = State::STARTED;
  52   start_time_ = pimpl_->surf_action_->get_start_time();
  53   on_start(*this);
  54   return this;
  55 }
  56
  57 Exec* Exec::wait()
  58 {
  59   return this->wait_for(-1);
  60 }
  61
  62 Exec* Exec::wait_for(double timeout)
  63 {
  64   if (state_ == State::INITED)
  65     vetoable_start();
  66
  67   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  68   kernel::actor::simcall_blocking([this, issuer, timeout] { this->get_impl()->wait_for(issuer, timeout); });
  69   complete(State::FINISHED);
  70   return this;
  71 }
  72
  73 int Exec::wait_any_for(std::vector<ExecPtr>* execs, double timeout)
  74 {
  75   std::vector<kernel::activity::ExecImpl*> rexecs(execs->size());
  76   std::transform(begin(*execs), end(*execs), begin(rexecs),
  77                  [](const ExecPtr& exec) { return static_cast<kernel::activity::ExecImpl*>(exec->pimpl_.get()); });
  78
  79   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  80   kernel::actor::ExecutionWaitanySimcall observer{issuer, rexecs, timeout};
  81   int changed_pos = kernel::actor::simcall_blocking(
  82       [&observer] {
  83         kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(), observer.get_timeout());
  84       },
  85       &observer);
  86   if (changed_pos != -1)
  87     execs->at(changed_pos)->complete(State::FINISHED);
  88   return changed_pos;
  89 }
  90
  91 /** @brief change the execution bound
  92  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  93  * deliver. Currently, this cannot be changed once the exec started.
  94  */
  95 ExecPtr Exec::set_bound(double bound)
  96 {
  97   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
  98              "Cannot change the bound of an exec after its start");
  99   kernel::actor::simcall(
 100       [this, bound] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bound(bound); });
 101   return this;
 102 }
 103
 104 /** @brief  Change the execution priority, don't you think?
 105  *
 106  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
 107  * The default priority is 1.
 108  *
 109  * Currently, this cannot be changed once the exec started. */
 110 ExecPtr Exec::set_priority(double priority)
 111 {
 112   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 113              "Cannot change the priority of an exec after its start");
 114   kernel::actor::simcall([this, priority] {
 115     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_sharing_penalty(1. / priority);
 116   });
 117   return this;
 118 }
 119
 120 ExecPtr Exec::set_timeout(double timeout) // XBT_ATTRIB_DEPRECATED_v329
 121 {
 122   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 123              "Cannot change the bound of an exec after its start");
 124   kernel::actor::simcall(
 125       [this, timeout] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_timeout(timeout); });
 126   return this;
 127 }
 128
 129 ExecPtr Exec::set_flops_amount(double flops_amount)
 130 {
 131   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 132       "Cannot change the flop_amount of an exec after its start");
 133   kernel::actor::simcall([this, flops_amount] {
 134     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
 135   });
 136   Activity::set_remaining(flops_amount);
 137   return this;
 138 }
 139
 140 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
 141 {
 142   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 143       "Cannot change the flops_amounts of an exec after its start");
 144   kernel::actor::simcall([this, flops_amounts] {
 145     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
 146   });
 147   parallel_      = true;
 148   return this;
 149 }
 150
 151 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
 152 {
 153   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 154       "Cannot change the bytes_amounts of an exec after its start");
 155   kernel::actor::simcall([this, bytes_amounts] {
 156     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
 157   });
 158   parallel_      = true;
 159   return this;
 160 }
 161
 162 /** @brief Retrieve the host on which this activity takes place.
 163  *  If it runs on more than one host, only the first host is returned.
 164  */
 165 Host* Exec::get_host() const
 166 {
 167   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
 168 }
 169 unsigned int Exec::get_host_number() const
 170 {
 171   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 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   sg_error_t status = SG_OK;
 300
 301   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 302   try {
 303     s4u_exec->wait_for(-1);
 304   } catch (const simgrid::TimeoutException&) {
 305     status = SG_ERROR_TIMEOUT;
 306   } catch (const simgrid::CancelException&) {
 307     status = SG_ERROR_CANCELED;
 308   } catch (const simgrid::HostFailureException&) {
 309     status = SG_ERROR_HOST;
 310   }
 311   return status;
 312 }
 313
 314 sg_error_t sg_exec_wait_for(sg_exec_t exec, double timeout)
 315 {
 316   sg_error_t status = SG_OK;
 317
 318   simgrid::s4u::ExecPtr s4u_exec(exec, false);
 319   try {
 320     s4u_exec->wait_for(timeout);
 321   } catch (const simgrid::TimeoutException&) {
 322     status = SG_ERROR_TIMEOUT;
 323   } catch (const simgrid::CancelException&) {
 324     status = SG_ERROR_CANCELED;
 325   } catch (const simgrid::HostFailureException&) {
 326     status = SG_ERROR_HOST;
 327   }
 328   return status;
 329 }
 330
 331 int sg_exec_wait_any(sg_exec_t* execs, size_t count)
 332 {
 333   return sg_exec_wait_any_for(execs, count, -1);
 334 }
 335
 336 int sg_exec_wait_any_for(sg_exec_t* execs, size_t count, double timeout)
 337 {
 338   std::vector<simgrid::s4u::ExecPtr> s4u_execs;
 339   for (unsigned int i = 0; i < count; i++)
 340     s4u_execs.emplace_back(execs[i], false);
 341
 342   int pos = simgrid::s4u::Exec::wait_any_for(&s4u_execs, timeout);
 343   for (unsigned i = 0; i < count; i++) {
 344     if (pos != -1 && static_cast<unsigned>(pos) != i)
 345       s4u_execs[i]->add_ref();
 346   }
 347   return pos;
 348 }