Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add new entry in Release_Notes.
[simgrid.git] / include / simgrid / s4u / Activity.hpp
index 0dade94..8b9f485 100644 (file)
@@ -12,6 +12,7 @@
 #include <simgrid/forward.h>
 #include <stdexcept>
 #include <string>
+#include <string_view>
 #include <vector>
 #include <xbt/Extendable.hpp>
 #include <xbt/asserts.h>
@@ -33,9 +34,11 @@ namespace s4u {
  */
 class XBT_PUBLIC Activity : public xbt::Extendable<Activity> {
 #ifndef DOXYGEN
+  friend ActivitySet;
   friend Comm;
   friend Exec;
   friend Io;
+  friend Mess;
   friend kernel::activity::ActivityImpl;
   friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
   friend std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
@@ -74,8 +77,8 @@ protected:
   {
     if(this == a)
       throw std::invalid_argument("Cannot be its own successor");
-    auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
-    if (p != successors_.end())
+
+    if (std::any_of(begin(successors_), end(successors_), [a](ActivityPtr const& i) { return i.get() == a.get(); }))
       throw std::invalid_argument("Dependency already exists");
 
     successors_.push_back(a);
@@ -87,12 +90,13 @@ protected:
     if(this == a)
       throw std::invalid_argument("Cannot ask to remove itself from successors list");
 
-    auto p = std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i){ return i.get() == a.get(); });
-    if (p != successors_.end()){
-      successors_.erase(p);
-      a->dependencies_.erase({this});
-    } else
+    auto p =
+        std::find_if(successors_.begin(), successors_.end(), [a](ActivityPtr const& i) { return i.get() == a.get(); });
+    if (p == successors_.end())
       throw std::invalid_argument("Dependency does not exist. Can not be removed.");
+
+    successors_.erase(p);
+    a->dependencies_.erase({this});
   }
 
   static std::set<Activity*>* vetoed_activities_;
@@ -102,16 +106,18 @@ protected:
    * It is forbidden to change the amount of work once the Activity is started */
   Activity* set_remaining(double remains);
 
-  virtual void fire_on_completion() const = 0;
-  virtual void fire_on_veto() const = 0;
-  virtual void fire_on_suspend() const = 0;
-  virtual void fire_on_resume() const = 0;
+  virtual void fire_on_start() const           = 0;
+  virtual void fire_on_this_start() const      = 0;
+  virtual void fire_on_completion() const      = 0;
+  virtual void fire_on_this_completion() const = 0;
+  virtual void fire_on_suspend() const         = 0;
+  virtual void fire_on_this_suspend() const    = 0;
+  virtual void fire_on_resume() const          = 0;
+  virtual void fire_on_this_resume() const     = 0;
+  virtual void fire_on_veto()                  = 0;
+  virtual void fire_on_this_veto()             = 0;
 
 public:
-  XBT_ATTRIB_DEPRECATED_v334("All start() are vetoable now. Please use start() ") void vetoable_start()
-  {
-    start();
-  }
   void start()
   {
     state_ = State::STARTING;
@@ -122,6 +128,7 @@ public:
       if (vetoed_activities_ != nullptr)
         vetoed_activities_->insert(this);
       fire_on_veto();
+      fire_on_this_veto();
     }
   }
 
@@ -132,6 +139,7 @@ public:
     ActivityPtr keepalive(this);
     state_ = state;
     fire_on_completion();
+    fire_on_this_completion();
     if (state == State::FINISHED)
       release_dependencies();
   }
@@ -151,8 +159,6 @@ public:
   virtual Activity* do_start() = 0;
   /** Tests whether the given activity is terminated yet. */
   virtual bool test();
-  /*! take a vector s4u::ActivityPtr and return the rank of the first finished one (or -1 if none is done). */
-  static ssize_t test_any(const std::vector<ActivityPtr>& activities);
 
   /** Blocks the current actor until the activity is terminated */
   Activity* wait() { return wait_for(-1.0); }
@@ -162,11 +168,6 @@ public:
   /** Blocks the current actor until the activity is terminated, or until the time limit is reached\n
    * Raises: timeout exception. */
   void wait_until(double time_limit);
-  /*! take a vector of s4u::ActivityPtr and return when one of them is finished.
-   * The return value is the rank of the first finished ActivityPtr. */
-  static ssize_t wait_any(const std::vector<ActivityPtr>& activities) { return wait_any_for(activities, -1); }
-  /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
-  static ssize_t wait_any_for(const std::vector<ActivityPtr>& activities, double timeout);
 
   /** Cancel that activity */
   Activity* cancel();
@@ -198,6 +199,9 @@ public:
   kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
 
 #ifndef DOXYGEN
+  static ssize_t deprecated_wait_any_for(const std::vector<ActivityPtr>& activities, double timeout); // XBT_ATTRIB_DEPRECATED_v339
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") static ssize_t test_any(const std::vector<ActivityPtr>& activities);
+
   friend void intrusive_ptr_release(Activity* a)
   {
     if (a->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
@@ -229,28 +233,60 @@ template <class AnyActivity> class Activity_T : public Activity {
   std::string name_             = "unnamed";
   std::string tracing_category_ = "";
 
-protected:
+  inline static xbt::signal<void(AnyActivity const&)> on_start;
+  xbt::signal<void(AnyActivity const&)> on_this_start;
   inline static xbt::signal<void(AnyActivity const&)> on_completion;
-  inline static xbt::signal<void(AnyActivity&)> on_veto;
+  xbt::signal<void(AnyActivity const&)> on_this_completion;
   inline static xbt::signal<void(AnyActivity const&)> on_suspend;
+  xbt::signal<void(AnyActivity const&)> on_this_suspend;
   inline static xbt::signal<void(AnyActivity const&)> on_resume;
+  xbt::signal<void(AnyActivity const&)> on_this_resume;
+  inline static xbt::signal<void(AnyActivity&)> on_veto;
+  xbt::signal<void(AnyActivity&)> on_this_veto;
+
+protected:
+  void fire_on_start() const override { on_start(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_this_start() const override { on_this_start(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_completion() const override { on_completion(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_this_completion() const override { on_this_completion(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_suspend() const override { on_suspend(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_this_suspend() const override { on_this_suspend(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_resume() const override { on_resume(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_this_resume() const override { on_this_resume(static_cast<const AnyActivity&>(*this)); }
+  void fire_on_veto() override { on_veto(static_cast<AnyActivity&>(*this)); }
+  void fire_on_this_veto() override { on_this_veto(static_cast<AnyActivity&>(*this)); }
 
 public:
-  /*! Add a callback fired when the activity completes (either normally, cancelled or failed) */
+  /*! \static Add a callback fired when any activity starts (no veto) */
+  static void on_start_cb(const std::function<void(AnyActivity const&)>& cb) { on_start.connect(cb); }
+  /*!  Add a callback fired when this specific activity starts (no veto) */
+  void on_this_start_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_start.connect(cb); }
+  /*! \static Add a callback fired when any activity completes (either normally, cancelled or failed) */
   static void on_completion_cb(const std::function<void(AnyActivity const&)>& cb) { on_completion.connect(cb); }
-  /*! Add a callback fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
-   * resource assigned) */
-  static void on_veto_cb(const std::function<void(AnyActivity&)>& cb) { on_veto.connect(cb); }
-  /*! Add a callback fired when the activity is suspended */
+  /*! Add a callback fired when this specific activity completes (either normally, cancelled or failed) */
+  void on_this_completion_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_completion.connect(cb); }
+  /*! \static Add a callback fired when any activity is suspended */
   static void on_suspend_cb(const std::function<void(AnyActivity const&)>& cb) { on_suspend.connect(cb); }
-  /*! Add a callback fired when the activity is resumed after being suspended */
+  /*! Add a callback fired when this specific activity is suspended */
+  void on_this_suspend_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_suspend.connect(cb); }
+  /*! \static Add a callback fired when any activity is resumed after being suspended */
   static void on_resume_cb(const std::function<void(AnyActivity const&)>& cb) { on_resume.connect(cb); }
+  /*! Add a callback fired when this specific activity is resumed after being suspended */
+  void on_this_resume_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_resume.connect(cb); }
+  /*! \static Add a callback fired each time that any activity fails to start because of a veto (e.g., unsolved
+   *  dependency or no resource assigned) */
+  static void on_veto_cb(const std::function<void(AnyActivity&)>& cb) { on_veto.connect(cb); }
+  /*! Add a callback fired each time that this specific activity fails to start because of a veto (e.g., unsolved
+   *  dependency or no resource assigned) */
+  void on_this_veto_cb(const std::function<void(AnyActivity&)>& cb) { on_this_veto.connect(cb); }
 
-  XBT_ATTRIB_DEPRECATED_v337("Please use on_suspend_cb() instead") static void on_suspended_cb(
-      const std::function<void(Activity const&)>& cb) { on_suspend.connect(cb); }
-  XBT_ATTRIB_DEPRECATED_v337("Please use on_resume_cb() instead") static void on_resumed_cb(
-      const std::function<void(Activity const&)>& cb) { on_resume.connect(cb);  }
+#ifndef DOXYGEN
+  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); }
+  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); }
 
+  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); }
+  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); }
+#endif
 
   AnyActivity* add_successor(ActivityPtr a)
   {
@@ -262,7 +298,7 @@ public:
     Activity::remove_successor(a);
     return static_cast<AnyActivity*>(this);
   }
-  AnyActivity* set_name(const std::string& name)
+  AnyActivity* set_name(std::string_view name)
   {
     name_ = name;
     return static_cast<AnyActivity*>(this);
@@ -270,7 +306,7 @@ public:
   const std::string& get_name() const override { return name_; }
   const char* get_cname() const override { return name_.c_str(); }
 
-  AnyActivity* set_tracing_category(const std::string& category)
+  AnyActivity* set_tracing_category(std::string_view category)
   {
     xbt_assert(get_state() == State::INITED || get_state() == State::STARTING,
                "Cannot change the tracing category of an activity after its start");
@@ -279,20 +315,6 @@ public:
   }
   const std::string& get_tracing_category() const { return tracing_category_; }
 
-  XBT_ATTRIB_DEPRECATED_v334("Please use Activity::set_data()") AnyActivity* set_user_data(void* data)
-  {
-    set_data(data);
-    return static_cast<AnyActivity*>(this);
-  }
-
-  XBT_ATTRIB_DEPRECATED_v334("Please use Activity::get_data<>()") void* get_user_data() const
-  {
-    return get_data<void>();
-  }
-  XBT_ATTRIB_DEPRECATED_v334("All start() are vetoable now. Please use start() ") AnyActivity* vetoable_start()
-  {
-    return start();
-  }
   AnyActivity* start()
   {
     Activity::start();