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