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