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