Update copyright lines for 2022.

[simgrid.git] / include / simgrid / s4u / Activity.hpp

diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp
index d64f99a..8a9e239 100644 (file)
--- a/include/simgrid/s4u/Activity.hpp
+++ b/include/simgrid/s4u/Activity.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,7 +6,6 @@
 #ifndef SIMGRID_S4U_ACTIVITY_HPP
 #define SIMGRID_S4U_ACTIVITY_HPP
 
-#include <xbt/asserts.h>
 #include <algorithm>
 #include <atomic>
 #include <set>
@@ -14,12 +13,17 @@
 #include <stdexcept>
 #include <string>
 #include <vector>
+#include <xbt/Extendable.hpp>
+#include <xbt/asserts.h>
 #include <xbt/signal.hpp>
 #include <xbt/utility.hpp>
 
 XBT_LOG_EXTERNAL_CATEGORY(s4u_activity);
 
 namespace simgrid {
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Activity>;
+
 namespace s4u {
 
 /** @brief Activities
@@ -27,10 +31,14 @@ namespace s4u {
  * This class is the ancestor of every activities that an actor can undertake.
  * That is, activities are all the things that do take time to the actor in the simulated world.
  */
-class XBT_PUBLIC Activity {
+class XBT_PUBLIC Activity : public xbt::Extendable<Activity> {
   friend Comm;
   friend Exec;
   friend Io;
+#ifndef DOXYGEN
+  friend std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
+  friend std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
+#endif
 
 public:
   // enum class State { ... }
@@ -38,17 +46,14 @@ public:
 
   virtual bool is_assigned() const = 0;
   virtual bool dependencies_solved() const { return dependencies_.empty(); }
+  virtual unsigned long is_waited_by() const { return successors_.size(); }
+  const std::set<ActivityPtr>& get_dependencies() const { return dependencies_; }
+  const std::vector<ActivityPtr>& get_successors() const { return successors_; }
 
 protected:
   Activity()  = default;
   virtual ~Activity() = default;
-
-  virtual void complete(Activity::State state)
-  {
-    state_ = state;
-    if (state == State::FINISHED)
-      release_dependencies();
-  }
+  void destroy();
 
   void release_dependencies()
   {
@@ -90,10 +95,16 @@ protected:
 
   static std::set<Activity*>* vetoed_activities_;
 
+private:
+  static xbt::signal<void(Activity&)> on_veto;
+  static xbt::signal<void(Activity&)> on_completion;
+
 public:
-  /*! Signal fired each time that the activity fails to start because of a veto (e.g., unsolved dependency or no
+  /*! 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 xbt::signal<void(Activity&)> on_veto;
+  static void on_veto_cb(const std::function<void(Activity&)>& cb) { on_veto.connect(cb); }
+  /*! Add a callback fired when theactivity completes (either normally, cancelled or failed) */
+  static void on_completion_cb(const std::function<void(Activity&)> cb) { on_completion.connect(cb); }
 
   void vetoable_start()
   {
@@ -108,6 +119,14 @@ public:
     }
   }
 
+  void complete(Activity::State state)
+  {
+    state_ = state;
+    on_completion(*this);
+    if (state == State::FINISHED)
+      release_dependencies();
+  }
+
   static std::set<Activity*>* get_vetoed_activities() { return vetoed_activities_; }
   static void set_vetoed_activities(std::set<Activity*>* whereto) { vetoed_activities_ = whereto; }
 
@@ -157,6 +176,11 @@ public:
    * It is forbidden to change the amount of work once the Activity is started */
   Activity* set_remaining(double remains);
 
+  double get_start_time() const;
+  double get_finish_time() const;
+  void mark() { marked_ = true; }
+  bool is_marked() const { return marked_; }
+
   /** Returns the internal implementation of this Activity */
   kernel::activity::ActivityImpl* get_impl() const { return pimpl_.get(); }
 
@@ -182,6 +206,7 @@ private:
   Activity::State state_                   = Activity::State::INITED;
   double remains_                          = 0;
   bool suspended_                          = false;
+  bool marked_                             = false;
   std::vector<ActivityPtr> successors_;
   std::set<ActivityPtr> dependencies_;
   std::atomic_int_fast32_t refcount_{0};