include/simgrid/s4u/Activity.hpp

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