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