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