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
  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   return ExecPtr(static_cast<Exec*>(pimpl->get_iface()));
  34 }
  35
  36 Exec* Exec::do_start()
  37 {
  38   kernel::actor::simcall_answered([this] {
  39     (*boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_))
  40         .set_name(get_name())
  41         .set_tracing_category(get_tracing_category())
  42         .start();
  43   });
  44
  45   if (suspended_)
  46     pimpl_->suspend();
  47
  48   state_      = State::STARTED;
  49   fire_on_start();
  50   fire_on_this_start();
  51   return this;
  52 }
  53
  54 ssize_t Exec::wait_any_for(const std::vector<ExecPtr>& execs, double timeout)
  55 {
  56   std::vector<ActivityPtr> activities;
  57   for (const auto& exec : execs)
  58     activities.push_back(boost::dynamic_pointer_cast<Activity>(exec));
  59   return Activity::wait_any_for(activities, timeout);
  60 }
  61
  62 /** @brief change the execution bound
  63  * This means changing the maximal amount of flops per second that it may consume, regardless of what the host may
  64  * deliver. Currently, this cannot be changed once the exec started.
  65  */
  66 ExecPtr Exec::set_bound(double bound)
  67 {
  68   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
  69              "Cannot change the bound of an exec after its start");
  70   kernel::actor::simcall_object_access(pimpl_.get(), [this, bound] {
  71     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bound(bound);
  72   });
  73   return this;
  74 }
  75
  76 /** @brief  Change the execution priority, don't you think?
  77  *
  78  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
  79  * The default priority is 1.
  80  *
  81  * Currently, this cannot be changed once the exec started. */
  82 ExecPtr Exec::set_priority(double priority)
  83 {
  84   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
  85              "Cannot change the priority of an exec after its start");
  86   kernel::actor::simcall_object_access(pimpl_.get(), [this, priority] {
  87     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_sharing_penalty(1. / priority);
  88   });
  89   return this;
  90 }
  91
  92 ExecPtr Exec::update_priority(double priority)
  93 {
  94   kernel::actor::simcall_answered([this, priority] {
  95     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->update_sharing_penalty(1. / priority);
  96   });
  97   return this;
  98 }
  99
 100 ExecPtr Exec::set_flops_amount(double flops_amount)
 101 {
 102   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 103       "Cannot change the flop_amount of an exec after its start");
 104   kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amount] {
 105     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amount(flops_amount);
 106   });
 107   set_remaining(flops_amount);
 108   return this;
 109 }
 110
 111 ExecPtr Exec::set_flops_amounts(const std::vector<double>& flops_amounts)
 112 {
 113   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 114       "Cannot change the flops_amounts of an exec after its start");
 115   kernel::actor::simcall_object_access(pimpl_.get(), [this, flops_amounts] {
 116     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_flops_amounts(flops_amounts);
 117   });
 118   parallel_      = true;
 119   return this;
 120 }
 121
 122 ExecPtr Exec::set_bytes_amounts(const std::vector<double>& bytes_amounts)
 123 {
 124   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 125       "Cannot change the bytes_amounts of an exec after its start");
 126   kernel::actor::simcall_object_access(pimpl_.get(), [this, bytes_amounts] {
 127     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_bytes_amounts(bytes_amounts);
 128   });
 129   parallel_      = true;
 130   return this;
 131 }
 132
 133 ExecPtr Exec::set_thread_count(int thread_count)
 134 {
 135   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 136              "Cannot change the bytes_amounts of an exec after its start");
 137   kernel::actor::simcall_object_access(pimpl_.get(), [this, thread_count] {
 138     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_thread_count(thread_count);
 139   });
 140   return this;
 141 }
 142
 143 /** @brief Retrieve the host on which this activity takes place.
 144  *  If it runs on more than one host, only the first host is returned.
 145  */
 146 Host* Exec::get_host() const
 147 {
 148   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host();
 149 }
 150 unsigned int Exec::get_host_number() const
 151 {
 152   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_host_number();
 153 }
 154
 155 int Exec::get_thread_count() const
 156 {
 157   return static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->get_thread_count();
 158 }
 159
 160 /** @brief Change the host on which this activity takes place.
 161  *
 162  * The activity cannot be terminated already (but it may be started). */
 163 ExecPtr Exec::set_host(Host* host)
 164 {
 165   xbt_assert(state_ == State::INITED || state_ == State::STARTING || state_ == State::STARTED,
 166              "Cannot change the host of an exec once it's done (state: %s)", to_c_str(state_));
 167
 168   if (state_ == State::STARTED)
 169     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 170
 171   kernel::actor::simcall_object_access(
 172       pimpl_.get(), [this, host] { boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_host(host); });
 173
 174   if (state_ == State::STARTING)
 175     // Setting the host may allow to start the activity, let's try
 176     start();
 177
 178   return this;
 179 }
 180
 181 ExecPtr Exec::set_hosts(const std::vector<Host*>& hosts)
 182 {
 183   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 184              "Cannot change the hosts of an exec once it's done (state: %s)", to_c_str(state_));
 185
 186   kernel::actor::simcall_object_access(pimpl_.get(), [this, hosts] {
 187     boost::static_pointer_cast<kernel::activity::ExecImpl>(pimpl_)->set_hosts(hosts);
 188   });
 189   parallel_ = true;
 190
 191   // Setting the host may allow to start the activity, let's try
 192   if (state_ == State::STARTING)
 193      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     start();
 209
 210     return this;
 211   }
 212 }
 213
 214 double Exec::get_cost() const
 215 {
 216   return (pimpl_->model_action_ == nullptr) ? -1 : pimpl_->model_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->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 }