include/simgrid/s4u/Activity.hpp

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