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