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