src/s4u/s4u_Exec.cpp

   1 /* Copyright (c) 2006-2019. 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/s4u/Actor.hpp"
   7 #include "simgrid/s4u/Exec.hpp"
   8 #include "src/kernel/activity/ExecImpl.hpp"
   9 #include "xbt/log.h"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
  12
  13 namespace simgrid {
  14 namespace s4u {
  15 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Exec::on_start;
  16 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Exec::on_completion;
  17
  18 Exec::Exec(sg_host_t host, double flops_amount) : Activity(), host_(host), flops_amount_(flops_amount)
  19 {
  20   Activity::set_remaining(flops_amount_);
  21   pimpl_ = simix::simcall([this] {
  22     return kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl(name_, tracing_category_,
  23                                                                         /*timeout_detector*/ nullptr, host_));
  24   });
  25 }
  26
  27 Exec* Exec::start()
  28 {
  29   simix::simcall(
  30       [this] { static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->start(flops_amount_, 1. / priority_, bound_); });
  31   state_ = State::STARTED;
  32   on_start(Actor::self());
  33   return this;
  34 }
  35
  36 Exec* Exec::cancel()
  37 {
  38   simgrid::simix::simcall([this] { static_cast<kernel::activity::ExecImpl*>(pimpl_.get())->cancel(); });
  39   state_ = State::CANCELED;
  40   return this;
  41 }
  42
  43 Exec* Exec::wait()
  44 {
  45   if (state_ == State::INITED)
  46     start();
  47   simcall_execution_wait(pimpl_);
  48   state_ = State::FINISHED;
  49   on_completion(Actor::self());
  50   return this;
  51 }
  52
  53 Exec* Exec::wait_for(double)
  54 {
  55   THROW_UNIMPLEMENTED;
  56   return this;
  57 }
  58
  59 /** @brief Returns whether the state of the exec is finished */
  60 bool Exec::test()
  61 {
  62   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
  63
  64   if (state_ == State::FINISHED)
  65     return true;
  66
  67   if (state_ == State::INITED)
  68     this->start();
  69
  70   if (simcall_execution_test(pimpl_)) {
  71     state_ = State::FINISHED;
  72     return true;
  73   }
  74
  75   return false;
  76 }
  77
  78 /** @brief  Change the execution priority, don't you think?
  79  *
  80  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
  81  * The default priority is 1.
  82  *
  83  * Currently, this cannot be changed once the exec started. */
  84 ExecPtr Exec::set_priority(double priority)
  85 {
  86   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
  87   priority_ = priority;
  88   return this;
  89 }
  90
  91 /** @brief change the execution bound, ie the maximal amount of flops per second that it may consume, regardless of what
  92  * the host may deliver
  93  *
  94  * Currently, this cannot be changed once the exec started. */
  95 ExecPtr Exec::set_bound(double bound)
  96 {
  97   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
  98   bound_ = bound;
  99   return this;
 100 }
 101
 102 /** @brief Change the host on which this activity takes place.
 103  *
 104  * The activity cannot be terminated already (but it may be started). */
 105 ExecPtr Exec::set_host(Host* host)
 106 {
 107   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
 108              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
 109   if (state_ == State::STARTED)
 110     boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->migrate(host);
 111   host_ = host;
 112   boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->host_ = host;
 113   return this;
 114 }
 115
 116 ExecPtr Exec::set_name(std::string name)
 117 {
 118   xbt_assert(state_ == State::INITED, "Cannot change the name of an exec after its start");
 119   name_ = std::move(name);
 120   return this;
 121 }
 122
 123 ExecPtr Exec::set_tracing_category(std::string category)
 124 {
 125   xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
 126   tracing_category_ = std::move(category);
 127   return this;
 128 }
 129
 130 /** @brief Retrieve the host on which this activity takes place. */
 131 Host* Exec::get_host()
 132 {
 133   return host_;
 134 }
 135
 136 /** @brief Returns the amount of flops that remain to be done */
 137 double Exec::get_remaining()
 138 {
 139   return simgrid::simix::simcall(
 140       [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
 141 }
 142
 143 /** @brief Returns the ratio of elements that are still to do
 144  *
 145  * The returned value is between 0 (completely done) and 1 (nothing done yet).
 146  */
 147 double Exec::get_remaining_ratio()
 148 {
 149   return simgrid::simix::simcall([this]() {
 150     return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining_ratio();
 151   });
 152 }
 153
 154 void intrusive_ptr_release(simgrid::s4u::Exec* e)
 155 {
 156   if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 157     std::atomic_thread_fence(std::memory_order_acquire);
 158     delete e;
 159   }
 160 }
 161
 162 void intrusive_ptr_add_ref(simgrid::s4u::Exec* e)
 163 {
 164   e->refcount_.fetch_add(1, std::memory_order_relaxed);
 165 }
 166 } // namespace s4u
 167 } // namespace simgrid