src/s4u/s4u_Exec.cpp

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