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