Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add on_this_veto signal to Activities
authorFred Suter <suterf@ornl.gov>
Wed, 31 May 2023 20:55:13 +0000 (16:55 -0400)
committerFred Suter <suterf@ornl.gov>
Wed, 31 May 2023 20:55:13 +0000 (16:55 -0400)
docs/source/Plugins.rst
include/simgrid/s4u/Activity.hpp
include/simgrid/s4u/Comm.hpp
include/simgrid/s4u/Exec.hpp
include/simgrid/s4u/Io.hpp

index b4e5b84..7050246 100644 (file)
@@ -143,6 +143,7 @@ Partial list of existing signals in s4u:
     :cpp:func:`Comm::on_resume <simgrid::s4u::Comm::on_resume_cb>`
     :cpp:func:`Comm::on_this_resume <simgrid::s4u::Comm::on_this_resume_cb>`
     :cpp:func:`Comm::on_veto <simgrid::s4u::Comm::on_veto_cb>`
+    :cpp:func:`Comm::on_this_veto <simgrid::s4u::Comm::on_this_veto_cb>`
   - :cpp:func:`Exec::on_start <simgrid::s4u::Exec::on_start_cb>`
     :cpp:func:`Exec::on_this_start <simgrid::s4u::Exec::on_this_start_cb>`
     :cpp:func:`Exec::on_completion <simgrid::s4u::Exec::on_completion_cb>`
@@ -152,6 +153,7 @@ Partial list of existing signals in s4u:
     :cpp:func:`Exec::on_resume <simgrid::s4u::Exec::on_resume_cb>`
     :cpp:func:`Exec::on_this_resume <simgrid::s4u::Exec::on_this_resume_cb>`
     :cpp:func:`Exec::on_veto <simgrid::s4u::Exec::on_veto_cb>`
+    :cpp:func:`Exec::on_this_veto <simgrid::s4u::Exec::on_this_veto_cb>`
   - :cpp:func:`Io::on_start <simgrid::s4u::Io::on_start_cb>`
     :cpp:func:`Io::on_this_start <simgrid::s4u::Io::on_this_start_cb>`
     :cpp:func:`Io::on_completion <simgrid::s4u::Io::on_completion_cb>`
@@ -161,6 +163,7 @@ Partial list of existing signals in s4u:
     :cpp:func:`Io::on_resume <simgrid::s4u::Io::on_resume_cb>`
     :cpp:func:`Io::on_this_resume <simgrid::s4u::Io::on_this_resume_cb>`
     :cpp:func:`Io::on_veto <simgrid::s4u::Io::on_veto_cb>`
+    :cpp:func:`Io::on_this_veto <simgrid::s4u::Io::on_this_veto_cb>`
 
 Existing Plugins
 ****************
index 506926b..8204458 100644 (file)
@@ -106,11 +106,12 @@ protected:
 
   virtual void fire_on_completion() const = 0;
   virtual void fire_on_this_completion() const = 0;
-  virtual void fire_on_veto() 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() const = 0;
+  virtual void fire_on_this_veto() const = 0;
 
 public:
   XBT_ATTRIB_DEPRECATED_v334("All start() are vetoable now. Please use start() ") void vetoable_start()
@@ -127,6 +128,7 @@ public:
       if (vetoed_activities_ != nullptr)
         vetoed_activities_->insert(this);
       fire_on_veto();
+      fire_on_this_veto();
     }
   }
 
@@ -238,25 +240,27 @@ template <class AnyActivity> class Activity_T : public Activity {
 protected:
   inline static xbt::signal<void(AnyActivity const&)> on_completion;
   xbt::signal<void(AnyActivity const&)> on_this_completion;
-  inline static xbt::signal<void(AnyActivity&)> on_veto;
   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;
 
 public:
   /*! Add a callback fired when the activity completes (either normally, cancelled or failed) */
   static void on_completion_cb(const std::function<void(AnyActivity const&)>& cb) { on_completion.connect(cb); }
   void on_this_completion_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_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 */
   static void on_suspend_cb(const std::function<void(AnyActivity const&)>& cb) { on_suspend.connect(cb); }
   void on_this_suspend_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_suspend.connect(cb); }
   /*! Add a callback fired when the activity is resumed after being suspended */
   static void on_resume_cb(const std::function<void(AnyActivity const&)>& cb) { on_resume.connect(cb); }
   void on_this_resume_cb(const std::function<void(AnyActivity const&)>& cb) { on_this_resume.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); }
+  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); }
index 2987d1f..393b48a 100644 (file)
@@ -55,11 +55,12 @@ protected:
        then Comm::on_completion is thrown in the kernel in CommImpl::finish.
      */
   }
-  void fire_on_veto() const override { on_veto(const_cast<Comm&>(*this)); }
   void fire_on_suspend() const override { on_suspend(*this); }
   void fire_on_this_suspend() const override { on_this_suspend(*this); }
   void fire_on_resume() const override { on_resume(*this); }
   void fire_on_this_resume() const override { on_this_resume(*this); }
+  void fire_on_veto() const override { on_veto(const_cast<Comm&>(*this)); }
+  void fire_on_this_veto() const override { on_this_veto(const_cast<Comm&>(*this)); }
 
 public:
   static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
index 63da309..720731b 100644 (file)
@@ -46,11 +46,12 @@ protected:
   xbt::signal<void(Exec const&)> on_this_start;
   void fire_on_completion() const override { on_completion(*this); }
   void fire_on_this_completion() const override { on_this_completion(*this); }
-  void fire_on_veto() const override { on_veto(const_cast<Exec&>(*this)); }
   void fire_on_suspend() const override { on_suspend(*this); }
   void fire_on_this_suspend() const override { on_this_suspend(*this); }
   void fire_on_resume() const override { on_resume(*this); }
   void fire_on_this_resume() const override { on_this_resume(*this); }
+  void fire_on_veto() const override { on_veto(const_cast<Exec&>(*this)); }
+  void fire_on_this_veto() const override { on_this_veto(const_cast<Exec&>(*this)); }
 
 public:
 #ifndef DOXYGEN
index f39fa19..cb75b50 100644 (file)
@@ -32,11 +32,12 @@ protected:
   Io* do_start() override;
   void fire_on_completion() const override { on_completion(*this); }
   void fire_on_this_completion() const override { on_this_completion(*this); }
-  void fire_on_veto() const override { on_veto(const_cast<Io&>(*this)); }
   void fire_on_suspend() const override { on_suspend(*this); }
   void fire_on_this_suspend() const override { on_this_suspend(*this); }
   void fire_on_resume() const override { on_resume(*this); }
   void fire_on_this_resume() const override { on_this_resume(*this); }
+  void fire_on_veto() const override { on_veto(const_cast<Io&>(*this)); }
+  void fire_on_this_veto() const override { on_this_veto(const_cast<Io&>(*this)); }
 
 public:
   enum class OpType { READ, WRITE };