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