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