src/s4u/s4u_Activity.cpp

   1 /* Copyright (c) 2006-2023. 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/Exception.hpp>
   7 #include <simgrid/s4u/Activity.hpp>
   8 #include <simgrid/s4u/Comm.hpp>
   9 #include <simgrid/s4u/Engine.hpp>
  10 #include <simgrid/s4u/Exec.hpp>
  11 #include <simgrid/s4u/Io.hpp>
  12 #include <xbt/log.h>
  13
  14 #include "src/kernel/activity/ActivityImpl.hpp"
  15 #include "src/kernel/actor/ActorImpl.hpp"
  16 #include "src/kernel/actor/CommObserver.hpp"
  17
  18 XBT_LOG_EXTERNAL_CATEGORY(s4u);
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_activity, s4u, "S4U activities");
  20
  21 namespace simgrid {
  22
  23 template class xbt::Extendable<s4u::Activity>;
  24
  25 namespace s4u {
  26
  27 std::set<Activity*>* Activity::vetoed_activities_ = nullptr;
  28
  29 void Activity::destroy()
  30 {
  31   /* First Remove all dependencies */
  32   while (not dependencies_.empty())
  33     (*(dependencies_.begin()))->remove_successor(this);
  34   while (not successors_.empty())
  35     this->remove_successor(successors_.front());
  36
  37   cancel();
  38 }
  39
  40 void Activity::wait_until(double time_limit)
  41 {
  42   double now = Engine::get_clock();
  43   if (time_limit > now)
  44     wait_for(time_limit - now);
  45 }
  46
  47 Activity* Activity::wait_for(double timeout)
  48 {
  49   if (state_ == State::INITED)
  50     start();
  51
  52   if (state_ == State::FAILED) {
  53     if (dynamic_cast<Comm*>(this))
  54       throw NetworkFailureException(XBT_THROW_POINT, "Cannot wait for a failed comm");
  55     if (dynamic_cast<Exec*>(this))
  56       throw HostFailureException(XBT_THROW_POINT, "Cannot wait for a failed exec");
  57     if (dynamic_cast<Io*>(this))
  58       throw StorageFailureException(XBT_THROW_POINT, "Cannot wait for a failed I/O");
  59     THROW_IMPOSSIBLE;
  60   }
  61
  62   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  63   kernel::actor::ActivityWaitSimcall observer{issuer, pimpl_.get(), timeout, "wait_for"};
  64   if (kernel::actor::simcall_blocking(
  65           [&observer] { observer.get_activity()->wait_for(observer.get_issuer(), observer.get_timeout()); }, &observer))
  66     throw TimeoutException(XBT_THROW_POINT, "Timeouted");
  67   complete(State::FINISHED);
  68   return this;
  69 }
  70
  71 bool Activity::test()
  72 {
  73   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::STARTING ||
  74              state_ == State::CANCELED || state_ == State::FINISHED);
  75
  76   if (state_ == State::CANCELED || state_ == State::FINISHED)
  77     return true;
  78
  79   if (state_ == State::INITED || state_ == State::STARTING)
  80     this->start();
  81
  82   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  83   kernel::actor::ActivityTestSimcall observer{issuer, pimpl_.get(), "test"};
  84   if (kernel::actor::simcall_answered([&observer] { return observer.get_activity()->test(observer.get_issuer()); },
  85                                       &observer)) {
  86     complete(State::FINISHED);
  87     return true;
  88   }
  89   return false;
  90 }
  91
  92 ssize_t Activity::test_any(const std::vector<ActivityPtr>& activities)
  93 {
  94   std::vector<kernel::activity::ActivityImpl*> ractivities(activities.size());
  95   std::transform(begin(activities), end(activities), begin(ractivities),
  96                  [](const ActivityPtr& act) { return act->pimpl_.get(); });
  97
  98   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  99   kernel::actor::ActivityTestanySimcall observer{issuer, ractivities, "test_any"};
 100   ssize_t changed_pos = kernel::actor::simcall_answered(
 101       [&observer] {
 102         return kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 103       },
 104       &observer);
 105   if (changed_pos != -1)
 106     activities.at(changed_pos)->complete(State::FINISHED);
 107   return changed_pos;
 108 }
 109
 110 ssize_t Activity::deprecated_wait_any_for(const std::vector<ActivityPtr>& activities, double timeout) // XBT_ATTRIB_DEPRECATED_v339
 111 {
 112   std::vector<kernel::activity::ActivityImpl*> ractivities(activities.size());
 113   std::transform(begin(activities), end(activities), begin(ractivities),
 114                  [](const ActivityPtr& activity) { return activity->pimpl_.get(); });
 115
 116   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 117   kernel::actor::ActivityWaitanySimcall observer{issuer, ractivities, timeout, "wait_any_for"};
 118   ssize_t changed_pos = kernel::actor::simcall_blocking(
 119       [&observer] {
 120         kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
 121                                                      observer.get_timeout());
 122       },
 123       &observer);
 124   if (changed_pos != -1)
 125     activities.at(changed_pos)->complete(State::FINISHED);
 126   return changed_pos;
 127 }
 128
 129 Activity* Activity::cancel()
 130 {
 131   kernel::actor::simcall_answered([this] {
 132     XBT_HERE();
 133     if (pimpl_)
 134       pimpl_->cancel();
 135   });
 136   complete(State::CANCELED);
 137   return this;
 138 }
 139
 140 Activity* Activity::suspend()
 141 {
 142   if (suspended_)
 143     return this; // Already suspended
 144   suspended_ = true;
 145
 146   if (state_ == State::STARTED)
 147     pimpl_->suspend();
 148
 149   return this;
 150 }
 151
 152 Activity* Activity::resume()
 153 {
 154   if (not suspended_)
 155     return this; // nothing to restore when it's not suspended
 156
 157   if (state_ == State::STARTED)
 158     pimpl_->resume();
 159
 160   return this;
 161 }
 162
 163 const char* Activity::get_state_str() const
 164 {
 165   return to_c_str(state_);
 166 }
 167
 168 double Activity::get_remaining() const
 169 {
 170   if (state_ == State::INITED || state_ == State::STARTING)
 171     return remains_;
 172   else
 173     return pimpl_->get_remaining();
 174 }
 175 double Activity::get_start_time() const
 176 {
 177   return pimpl_->get_start_time();
 178 }
 179 double Activity::get_finish_time() const
 180 {
 181   return pimpl_->get_finish_time();
 182 }
 183
 184 Activity* Activity::set_remaining(double remains)
 185 {
 186   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 187              "Cannot change the remaining amount of work once the Activity is started");
 188   remains_ = remains;
 189   return this;
 190 }
 191
 192 } // namespace s4u
 193 } // namespace simgrid