include/simgrid/s4u/Activity.hpp

   1 /* Copyright (c) 2006-2021. 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 #ifndef SIMGRID_S4U_ACTIVITY_HPP
   7 #define SIMGRID_S4U_ACTIVITY_HPP
   8
   9 #include <xbt/asserts.h>
  10 #include <algorithm>
  11 #include <atomic>
  12 #include <set>
  13 #include <simgrid/forward.h>
  14 #include <stdexcept>
  15 #include <string>
  16 #include <vector>
  17 #include <xbt/signal.hpp>
  18 #include <xbt/utility.hpp>
  19
  20 XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
  21
  22 namespace simgrid {
  23 namespace s4u {
  24
  25 /** @brief Activities
  26  *
  27  * This class is the ancestor of every activities that an actor can undertake.
  28  * That is, activities are all the things that do take time to the actor in the simulated world.
  29  */
  30 class XBT_PUBLIC Activity {
  31   friend Comm;
  32   friend Exec;
  33   friend Io;
  34 #ifndef DOXYGEN
  35   friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
  36 #endif
  37
  38 public:
  39   // enum class State { ... }
  40   XBT_DECLARE_ENUM_CLASS(State, INITED, STARTING, STARTED, FAILED, CANCELED, FINISHED);
  41
  42   virtual bool is_assigned() const = 0;
  43   virtual bool dependencies_solved() const { return dependencies_.empty(); }
  44   virtual unsigned long is_waited_by() const { return successors_.size(); }
  45   const std::set<ActivityPtr>& get_dependencies() const { return dependencies_; }
  46   const std::vector<ActivityPtr>& get_successors() const { return successors_; }
  47
  48 protected:
  49   Activity()  = default;
  50   virtual ~Activity() = default;
  51
  52   void release_dependencies()
  53   {
  54     while (not successors_.empty()) {
  55       ActivityPtr b = successors_.back();
  56       XBT_CVERB(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
  57       b->dependencies_.erase(this);
  58       if (b->dependencies_solved()) {
  59         b->vetoable_start();
  60       }
  61       successors_.pop_back();
  62     }
  63   }
  64
  65   void add_successor(ActivityPtr a)
  66   {
  67     if(this == a)
  68       throw std::invalid_argument("Cannot be its own successor");
  69     auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
  70     if (p != successors_.end())
  71       throw std::invalid_argument("Dependency already exists");
  72
  73     successors_.push_back(a);
  74     a->dependencies_.insert({this});
  75   }
  76
  77   void remove_successor(ActivityPtr a)
  78   {
  79     if(this == a)
  80       throw std::invalid_argument("Cannot ask to remove itself from successors list");
  81
  82     auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
  83     if (p != successors_.end()){
  84       successors_.erase(p);
  85       a->dependencies_.erase({this});
  86     } else
  87       throw std::invalid_argument("Dependency does not exist. Can not be removed.");
  88   }
  89
  90   static std::set<Activity*>* vetoed_activities_;
  91
  92 public:
  93   /*! Signal fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
  94    * resource assigned) */
  95   static xbt::signal<void(Activity&)> on_veto;
  96   /*! Signal fired when theactivity completes  (either normally, cancelled or failed) */
  97   static xbt::signal<void(Activity&)> on_completion;
  98
  99   void vetoable_start()
 100   {
 101     state_ = State::STARTING;
 102     if (dependencies_solved() && is_assigned()) {
 103       XBT_CVERB(s4u_activity, "'%s' is assigned to a resource and all dependencies are solved. Let's start", get_cname());
 104       start();
 105     } else {
 106       if (vetoed_activities_ != nullptr)
 107         vetoed_activities_->insert(this);
 108       on_veto(*this);
 109     }
 110   }
 111
 112   void complete(Activity::State state)
 113   {
 114     state_ = state;
 115     if (state == State::FINISHED)
 116       release_dependencies();
 117     on_completion(*this);
 118   }
 119
 120   static std::set<Activity*>* get_vetoed_activities() { return vetoed_activities_; }
 121   static void set_vetoed_activities(std::set<Activity*>* whereto) { vetoed_activities_ = whereto; }
 122
 123 #ifndef DOXYGEN
 124   Activity(Activity const&) = delete;
 125   Activity& operator=(Activity const&) = delete;
 126 #endif
 127
 128   /** Starts a previously created activity.
 129    *
 130    * This function is optional: you can call wait() even if you didn't call start()
 131    */
 132   virtual Activity* start() = 0;
 133   /** Blocks the current actor until the activity is terminated */
 134   Activity* wait() { return wait_for(-1.0); }
 135   /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
 136    *  Raises: timeout exception.*/
 137   Activity* wait_for(double timeout);
 138   /** Blocks the current actor until the activity is terminated, or until the time limit is reached\n
 139    * Raises: timeout exception. */
 140   void wait_until(double time_limit);
 141
 142   /** Cancel that activity */
 143   Activity* cancel();
 144   /** Retrieve the current state of the activity */
 145   Activity::State get_state() const { return state_; }
 146   /** Return a string representation of the activity's state (one of INITED, STARTING, STARTED, CANCELED, FINISHED) */
 147   const char* get_state_str() const;
 148   void set_state(Activity::State state) { state_ = state; }
 149   /** Tests whether the given activity is terminated yet. */
 150   virtual bool test();
 151
 152   /** Blocks the progression of this activity until it gets resumed */
 153   virtual Activity* suspend();
 154   /** Unblock the progression of this activity if it was suspended previously */
 155   virtual Activity* resume();
 156   /** Whether or not the progression of this activity is blocked */
 157   bool is_suspended() const { return suspended_; }
 158
 159   virtual const char* get_cname() const       = 0;
 160   virtual const std::string& get_name() const = 0;
 161
 162   /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
 163   virtual double get_remaining() const;
 164   /** Set the [remaining] amount of work that this Activity will entail
 165    *
 166    * It is forbidden to change the amount of work once the Activity is started */
 167   Activity* set_remaining(double remains);
 168
 169   double get_start_time() const;
 170   double get_finish_time() const;
 171   void mark() { marked_ = true; }
 172   bool is_marked() const { return marked_; }
 173
 174   /** Returns the internal implementation of this Activity */
 175   kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
 176
 177 #ifndef DOXYGEN
 178   friend void intrusive_ptr_release(Activity* a)
 179   {
 180     if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 181       std::atomic_thread_fence(std::memory_order_acquire);
 182       delete a;
 183     }
 184   }
 185   friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
 186 #endif
 187   Activity* add_ref()
 188   {
 189     intrusive_ptr_add_ref(this);
 190     return this;
 191   }
 192   void unref() { intrusive_ptr_release(this); }
 193
 194 private:
 195   kernel::activity::ActivityImplPtr pimpl_ = nullptr;
 196   Activity::State state_                   = Activity::State::INITED;
 197   double remains_                          = 0;
 198   bool suspended_                          = false;
 199   bool marked_                             = false;
 200   std::vector<ActivityPtr> successors_;
 201   std::set<ActivityPtr> dependencies_;
 202   std::atomic_int_fast32_t refcount_{0};
 203 };
 204
 205 template <class AnyActivity> class Activity_T : public Activity {
 206   std::string name_             = "unnamed";
 207   std::string tracing_category_ = "";
 208   void* user_data_              = nullptr;
 209
 210 public:
 211   AnyActivity* add_successor(ActivityPtr a)
 212   {
 213     Activity::add_successor(a);
 214     return static_cast<AnyActivity*>(this);
 215   }
 216   AnyActivity* remove_successor(ActivityPtr a)
 217   {
 218     Activity::remove_successor(a);
 219     return static_cast<AnyActivity*>(this);
 220   }
 221   AnyActivity* set_name(const std::string& name)
 222   {
 223     xbt_assert(get_state() == State::INITED, "Cannot change the name of an activity after its start");
 224     name_ = name;
 225     return static_cast<AnyActivity*>(this);
 226   }
 227   const std::string& get_name() const override { return name_; }
 228   const char* get_cname() const override { return name_.c_str(); }
 229
 230   AnyActivity* set_tracing_category(const std::string& category)
 231   {
 232     xbt_assert(get_state() == State::INITED, "Cannot change the tracing category of an activity after its start");
 233     tracing_category_ = category;
 234     return static_cast<AnyActivity*>(this);
 235   }
 236   const std::string& get_tracing_category() const { return tracing_category_; }
 237
 238   AnyActivity* set_user_data(void* data)
 239   {
 240     user_data_ = data;
 241     return static_cast<AnyActivity*>(this);
 242   }
 243
 244   void* get_user_data() const { return user_data_; }
 245
 246   AnyActivity* vetoable_start()
 247   {
 248     Activity::vetoable_start();
 249     return static_cast<AnyActivity*>(this);
 250   }
 251
 252   AnyActivity* cancel() { return static_cast<AnyActivity*>(Activity::cancel()); }
 253   AnyActivity* wait() { return wait_for(-1.0); }
 254   virtual AnyActivity* wait_for(double timeout) { return static_cast<AnyActivity*>(Activity::wait_for(timeout)); }
 255
 256 #ifndef DOXYGEN
 257   /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
 258    * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and
 259    * add_ref to the Activity class. Hopefully, the "inline" helps to not hinder the perf here.
 260    */
 261   friend void inline intrusive_ptr_release(AnyActivity* a) { intrusive_ptr_release(static_cast<Activity*>(a)); }
 262   friend void inline intrusive_ptr_add_ref(AnyActivity* a) { intrusive_ptr_add_ref(static_cast<Activity*>(a)); }
 263 #endif
 264 };
 265
 266 } // namespace s4u
 267 } // namespace simgrid
 268
 269 #endif /* SIMGRID_S4U_ACTIVITY_HPP */