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