Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
when enable_debug is turned off, these tests were failing.
[simgrid.git] / include / simgrid / s4u / Activity.hpp
index 67fe59b..fbf8993 100644 (file)
@@ -27,46 +27,82 @@ namespace s4u {
 class XBT_PUBLIC Activity {
   friend Comm;
   friend Exec;
-  friend ExecSeq;
-  friend ExecPar;
   friend Io;
 
 protected:
   Activity()  = default;
   virtual ~Activity() = default;
+
+  void release_dependencies()
+  {
+    while (not successors_.empty()) {
+      ActivityPtr b = successors_.back();
+      XBT_CVERB(s4u_activity, "Remove a dependency from '%s' on '%s'", get_cname(), b->get_cname());
+      b->dependencies_.erase(this);
+      if (b->dependencies_.empty()) {
+        b->vetoable_start();
+      }
+      successors_.pop_back();
+    }
+  }
+
+  void add_successor(ActivityPtr a)
+  {
+    successors_.push_back(a);
+    a->dependencies_.insert({this});
+  }
+
 public:
+  void vetoable_start()
+  {
+    state_ = State::STARTING;
+    if (dependencies_.empty()) {
+      XBT_CVERB(s4u_activity, "All dependencies are solved, let's start '%s'", get_cname());
+      start();
+    }
+  }
+
 #ifndef DOXYGEN
   Activity(Activity const&) = delete;
   Activity& operator=(Activity const&) = delete;
 #endif
 
-  enum class State { INITED = 0, STARTING, STARTED, CANCELED, ERRORED, FINISHED };
+  enum class State { INITED = 0, STARTING, STARTED, CANCELED, FINISHED };
 
   /** Starts a previously created activity.
    *
    * This function is optional: you can call wait() even if you didn't call start()
    */
   virtual Activity* start() = 0;
-  /** Blocks until the activity is terminated */
+  /** Blocks the current actor until the activity is terminated */
   virtual Activity* wait() = 0;
-  /** Blocks until the activity is terminated, or until the timeout is elapsed
+  /** Blocks the current actor until the activity is terminated, or until the timeout is elapsed\n
    *  Raises: timeout exception.*/
   virtual Activity* wait_for(double timeout) = 0;
-  /** Blocks until the activity is terminated, or until the time limit is reached
+  /** 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);
 
   /** Cancel that activity */
   virtual Activity* cancel() = 0;
   /** Retrieve the current state of the activity */
-  Activity::State get_state() { return state_; }
+  Activity::State get_state() const { return state_; }
   void set_state(Activity::State state) { state_ = state; }
-  /** Tests whether the given activity is terminated yet. This is a pure function. */
-  virtual bool test() = 0;
+  /** Tests whether the given activity is terminated yet. */
+  virtual bool test();
 
-  /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
-  virtual double get_remaining();
+  /** Blocks the progression of this activity until it gets resumed */
+  virtual Activity* suspend();
+  /** Unblock the progression of this activity if it was suspended previously */
+  virtual Activity* resume();
+  /** Whether or not the progression of this activity is blocked */
+  bool is_suspended() const { return suspended_; }
+
+  virtual const char* get_cname() const       = 0;
+  virtual const std::string& get_name() const = 0;
 
+  /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
+  virtual double get_remaining() const;
   /** Set the [remaining] amount of work that this Activity will entail
    *
    * It is forbidden to change the amount of work once the Activity is started */
@@ -85,58 +121,32 @@ public:
   }
   friend void intrusive_ptr_add_ref(Activity* a) { a->refcount_.fetch_add(1, std::memory_order_relaxed); }
 #endif
+  Activity* add_ref()
+  {
+    intrusive_ptr_add_ref(this);
+    return this;
+  }
+  void unref() { intrusive_ptr_release(this); }
+
 private:
   kernel::activity::ActivityImplPtr pimpl_ = nullptr;
   Activity::State state_                   = Activity::State::INITED;
   double remains_                          = 0;
+  bool suspended_                          = false;
+  std::vector<ActivityPtr> successors_;
+  std::set<ActivityPtr> dependencies_;
   std::atomic_int_fast32_t refcount_{0};
 };
 
 template <class AnyActivity> class Activity_T : public Activity {
-private:
   std::string name_             = "unnamed";
   std::string tracing_category_ = "";
   void* user_data_              = nullptr;
-  std::vector<Activity*> successors_;
-  std::set<Activity*> dependencies_;
 
 public:
-
-  void add_successor(Activity* a)
-  {
-    successors_.push_back(a);
-    static_cast<AnyActivity*>(a)->add_dependency_on(static_cast<Activity*>(this));
-  }
-  void remove_successor() { successors_.pop_back(); }
-  Activity* get_successor() { return successors_.back(); }
-  bool has_successors() { return not successors_.empty(); }
-
-  void add_dependency_on(Activity* a) { dependencies_.insert({a}); }
-  void remove_dependency_on(Activity* a) { dependencies_.erase(a); }
-  bool has_dependencies() { return not dependencies_.empty(); }
-  void release_dependencies()
-  {
-    while (has_successors()) {
-      AnyActivity* b = static_cast<AnyActivity*>(get_successor());
-      XBT_CDEBUG(s4u_activity, "Remove a dependency from '%s' on '%s'", static_cast<AnyActivity*>(this)->get_cname(),
-                 b->get_cname());
-      b->remove_dependency_on(static_cast<Activity*>(this));
-      if (not b->has_dependencies()) {
-        b->vetoable_start();
-      }
-      remove_successor();
-    }
-  }
-
-  AnyActivity* vetoable_start()
+  AnyActivity* add_successor(ActivityPtr a)
   {
-    set_state(State::STARTING);
-    if (has_dependencies())
-      return static_cast<AnyActivity*>(this);
-    set_state(State::STARTED);
-    XBT_CDEBUG(s4u_activity, "All dependencies are solved, let's start '%s'",
-               static_cast<AnyActivity*>(this)->get_cname());
-    static_cast<AnyActivity*>(this)->start();
+    Activity::add_successor(a);
     return static_cast<AnyActivity*>(this);
   }
 
@@ -146,8 +156,8 @@ public:
     name_ = name;
     return static_cast<AnyActivity*>(this);
   }
-  const std::string& get_name() { return name_; }
-  const char* get_cname() { return name_.c_str(); }
+  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)
   {
@@ -155,7 +165,7 @@ public:
     tracing_category_ = category;
     return static_cast<AnyActivity*>(this);
   }
-  const std::string& get_tracing_category() { return tracing_category_; }
+  const std::string& get_tracing_category() const { return tracing_category_; }
 
   AnyActivity* set_user_data(void* data)
   {
@@ -163,7 +173,7 @@ public:
     return static_cast<AnyActivity*>(this);
   }
 
-  void* get_user_data() { return user_data_; }
+  void* get_user_data() const { return user_data_; }
 #ifndef DOXYGEN
   /* The refcounting is done in the ancestor class, Activity, but we want each of the classes benefiting of the CRTP
    * (Exec, Comm, etc) to have smart pointers too, so we define these methods here, that forward the ptr_release and