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