src/s4u/s4u_Exec.cpp

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