src/s4u/s4u_Activity.cpp

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