src/s4u/s4u_Exec.cpp

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