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